diff --git a/generated-docs/changelogs/api-key-stamper/readme.mdx b/generated-docs/changelogs/api-key-stamper/readme.mdx index bbb924c40..0dd89e299 100644 --- a/generated-docs/changelogs/api-key-stamper/readme.mdx +++ b/generated-docs/changelogs/api-key-stamper/readme.mdx @@ -1,10 +1,64 @@ --- -title: "API Key Stamper" +title: "Api Key Stamper" mode: wide --- - + # @turnkey/api-key-stamper +## 0.4.8-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.4 + +## 0.4.8-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.3 + +## 0.4.8-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.2 + +## 0.4.8-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.1 + +## 0.4.8-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.0 + +## 0.4.7 + +### Patch Changes + +- [#698](https://github.com/tkhq/sdk/pull/698) [`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164) Author [@moeodeh3](https://github.com/moeodeh3) - Introduces an optional `runtimeOverride` parameter that allows the ability to explicitly specify the crypto environment: `"browser"`, `"node"`, or `"purejs"`. + +## 0.4.6 + +### Patch Changes + +- Updated dependencies [[`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a)]: + - @turnkey/encoding@0.5.0 + +## 0.4.5 + +### Patch Changes + +- 4d1d775: Better error message and docstring for API key import + ## 0.4.4 ### Patch Changes @@ -67,4 +121,4 @@ mode: wide ## 0.1.0 -Initial release +Initial release \ No newline at end of file diff --git a/generated-docs/changelogs/core/readme.mdx b/generated-docs/changelogs/core/readme.mdx new file mode 100644 index 000000000..c2a00bfe6 --- /dev/null +++ b/generated-docs/changelogs/core/readme.mdx @@ -0,0 +1,118 @@ +--- +title: "Core" +mode: wide +--- + +# @turnkey/core + +## 1.0.0-beta.4 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.4 + - @turnkey/encoding@0.6.0-beta.4 + - @turnkey/http@3.10.0-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + - @turnkey/crypto@2.5.1-beta.4 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.4 + +## 1.0.0-beta.3 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.3 + - @turnkey/encoding@0.6.0-beta.3 + - @turnkey/http@3.10.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + - @turnkey/crypto@2.5.1-beta.3 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.3 + +## 1.0.0-beta.2 + +### Minor Changes + +- updating package versions + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.2 + - @turnkey/encoding@0.6.0-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/crypto@2.5.1-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.2 + +## 1.0.0-beta.1 + +### Minor Changes + +- test build + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.1 + - @turnkey/encoding@0.6.0-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.1 + - @turnkey/crypto@2.5.1-beta.1 + - @turnkey/http@3.8.1-beta.1 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.1 + +## 1.0.0-beta.0 + +### Major Changes + +- beta for @turnkey/react-wallet-kit and @turnkey/core + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.0 + - @turnkey/encoding@0.6.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/crypto@2.5.1-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.0 + +## 1.0.0 + +### Major Changes + +- Initial beta release for react wallet kit + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0 + - @turnkey/encoding@0.6.0 + - @turnkey/api-key-stamper@0.4.8 + - @turnkey/crypto@2.5.1 + - @turnkey/http@3.8.1 + - @turnkey/react-native-passkey-stamper@1.1.2 + +## 1.0.0 + +### Major Changes + +- Initial beta release for @turnkey/react-wallet-kit and @turnkey/core + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0 + - @turnkey/encoding@0.6.0 + - @turnkey/api-key-stamper@0.4.8 + - @turnkey/crypto@2.5.1 + - @turnkey/http@3.8.1 + - @turnkey/react-native-passkey-stamper@1.1.2 \ No newline at end of file diff --git a/generated-docs/changelogs/cosmjs/readme.mdx b/generated-docs/changelogs/cosmjs/readme.mdx index 033ec9350..b876d97ce 100644 --- a/generated-docs/changelogs/cosmjs/readme.mdx +++ b/generated-docs/changelogs/cosmjs/readme.mdx @@ -2,9 +2,232 @@ title: "Cosmjs" mode: wide --- - + # @turnkey/cosmjs +## 0.7.25-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.1 + - @turnkey/http@3.10.0-beta.1 + - @turnkey/sdk-browser@5.7.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + +## 0.7.25-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.0 + - @turnkey/http@3.10.0-beta.0 + - @turnkey/sdk-browser@5.7.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + +## 0.7.25-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/sdk-server@4.5.1-beta.2 + +## 0.7.25-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.1 + - @turnkey/http@3.8.1-beta.1 + - @turnkey/sdk-server@4.5.1-beta.1 + +## 0.7.25-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/sdk-server@4.5.1-beta.0 + +## 0.7.25 + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9), [`1a549b7`](https://github.com/tkhq/sdk/commit/1a549b71f9a6e7ab59d52aaae7e58e34c8f2e8b5)]: + - @turnkey/sdk-browser@5.7.0 + - @turnkey/sdk-server@4.6.0 + - @turnkey/http@3.9.0 + +## 0.7.24 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/sdk-browser@5.6.0 + - @turnkey/sdk-server@4.5.0 + - @turnkey/http@3.8.0 + +## 0.7.23 + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed)]: + - @turnkey/http@3.7.0 + - @turnkey/sdk-browser@5.5.0 + - @turnkey/sdk-server@4.4.0 + +## 0.7.22 + +### Patch Changes + +- Updated dependencies [[`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15)]: + - @turnkey/sdk-browser@5.4.1 + +## 0.7.21 + +### 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.7.20 + +### Patch Changes + +- Updated dependencies [[`2db00b0`](https://github.com/tkhq/sdk/commit/2db00b0a799d09ae33fa08a117e3b2f433f2b0b4)]: + - @turnkey/sdk-server@4.2.4 + +## 0.7.19 + +### 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.7.18 + +### Patch Changes + +- Updated dependencies [[`2c4f42c`](https://github.com/tkhq/sdk/commit/2c4f42c747ac8017cf17e86b0ca0c3fa6f593bbf)]: + - @turnkey/sdk-browser@5.3.3 + +## 0.7.17 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.3.2 + - @turnkey/sdk-server@4.2.2 + +## 0.7.16 + +### 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.7.15 + +### 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.7.14 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.3 + +## 0.7.13 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.2 + +## 0.7.12 + +### 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.7.11 + +### 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.7.10 + +### 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.7.9 + +### 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.7.8 + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/sdk-browser@4.3.0 + - @turnkey/sdk-server@3.3.0 + - @turnkey/http@3.3.0 + +## 0.7.7 + +### 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.7.6 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/sdk-browser@4.1.0 + - @turnkey/sdk-server@3.1.0 + - @turnkey/http@3.1.0 + ## 0.7.5 ### Patch Changes @@ -529,4 +752,4 @@ mode: wide ## 0.1.0 -- Initial release +- Initial release \ No newline at end of file diff --git a/generated-docs/changelogs/crypto/readme.mdx b/generated-docs/changelogs/crypto/readme.mdx index 3f4380b09..8b9ab343f 100644 --- a/generated-docs/changelogs/crypto/readme.mdx +++ b/generated-docs/changelogs/crypto/readme.mdx @@ -2,9 +2,76 @@ title: "Crypto" mode: wide --- - + # @turnkey/crypto +## 2.5.1-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.4 + +## 2.5.1-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.3 + +## 2.5.1-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.2 + +## 2.5.1-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.1 + +## 2.5.1-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.0 + +## 2.5.0 + +### Minor Changes + +- [#812](https://github.com/tkhq/sdk/pull/812) [`6cde41c`](https://github.com/tkhq/sdk/commit/6cde41cfecdfb7d54abf52cc65e28ef0e2ad6ba3) Author [@turnekybc](https://github.com/turnekybc) - Add `@turnkey/encoding` as a package dependency instead of a devDependency to `@turnkey/crypto`. This resolves an issue with transitive dependencies when devDependencies are not included in the artifact. + +## 2.4.3 + +### Patch Changes + +- [#720](https://github.com/tkhq/sdk/pull/720) [`6cbff7a`](https://github.com/tkhq/sdk/commit/6cbff7a0c0b3a9a05586399e5cef476154d3bdca) Author [@moeodeh3](https://github.com/moeodeh3) - Fixed `decryptExportBundle` not working in some environments by adding a shim to handle `bs58`'s ESM-only export. + +## 2.4.2 + +### Patch Changes + +- [#699](https://github.com/tkhq/sdk/pull/699) [`c5cdf82`](https://github.com/tkhq/sdk/commit/c5cdf8229da5da1bd6d52db06b2fe42826e96d57) Author [@andrewkmin](https://github.com/andrewkmin) - Add validations to `fromDerSignature` for parsing DER signatures in the Turnkey context + +- [#716](https://github.com/tkhq/sdk/pull/716) [`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79) Author [@moeodeh3](https://github.com/moeodeh3) - Fixed `decryptCredentialBundle` not working in React Native by adding a shim to handle `bs58check`'s ESM-only export. + +## 2.4.1 + +### Patch Changes + +- [#700](https://github.com/tkhq/sdk/pull/700) [`878e039`](https://github.com/tkhq/sdk/commit/878e03973856cfec83e6e3fda5b76d1b64943628) Author [@andrewkmin](https://github.com/andrewkmin) - Add validations to uncompressRawPublicKey method + +## 2.4.0 + +### Minor Changes + +- [#662](https://github.com/tkhq/sdk/pull/662) [`10ee5c5`](https://github.com/tkhq/sdk/commit/10ee5c524b477ce998e4fc635152cd101ae5a9cc) Thanks [@moe-dev](https://github.com/moe-dev)! - Add function `verifySessionJwtSignature` to verify session tokens return from Turnkey and signed by the notarizer + ## 2.3.1 ### Patch Changes @@ -84,4 +151,4 @@ mode: wide ## 0.1.0 -Initial release +Initial release \ No newline at end of file diff --git a/generated-docs/changelogs/eip-1193-provider/readme.mdx b/generated-docs/changelogs/eip-1193-provider/readme.mdx index 2d102eb01..924e15055 100644 --- a/generated-docs/changelogs/eip-1193-provider/readme.mdx +++ b/generated-docs/changelogs/eip-1193-provider/readme.mdx @@ -2,9 +2,213 @@ title: "Eip 1193 Provider" mode: wide --- - + # @turnkey/eip-1193-provider +## 3.4.0-beta.4 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/http@3.10.0-beta.1 + - @turnkey/sdk-browser@5.7.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + +## 3.4.0-beta.3 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/http@3.10.0-beta.0 + - @turnkey/sdk-browser@5.7.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + +## 3.3.24-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/http@3.8.1-beta.2 + +## 3.3.24-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.1 + - @turnkey/http@3.8.1-beta.1 + +## 3.3.24-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/http@3.8.1-beta.0 + +## 3.3.24 + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9)]: + - @turnkey/sdk-browser@5.7.0 + - @turnkey/http@3.9.0 + +## 3.3.23 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/sdk-browser@5.6.0 + - @turnkey/http@3.8.0 + +## 3.3.22 + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed)]: + - @turnkey/http@3.7.0 + - @turnkey/sdk-browser@5.5.0 + +## 3.3.21 + +### Patch Changes + +- Updated dependencies [[`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15)]: + - @turnkey/sdk-browser@5.4.1 + +## 3.3.20 + +### Patch Changes + +- Updated dependencies [[`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e)]: + - @turnkey/sdk-browser@5.4.0 + - @turnkey/http@3.6.0 + +## 3.3.19 + +### Patch Changes + +- Updated dependencies [[`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a)]: + - @turnkey/sdk-browser@5.3.4 + - @turnkey/http@3.5.1 + +## 3.3.18 + +### Patch Changes + +- Updated dependencies [[`2c4f42c`](https://github.com/tkhq/sdk/commit/2c4f42c747ac8017cf17e86b0ca0c3fa6f593bbf)]: + - @turnkey/sdk-browser@5.3.3 + +## 3.3.17 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.3.2 + +## 3.3.16 + +### Patch Changes + +- Updated dependencies [[`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]: + - @turnkey/sdk-browser@5.3.1 + +## 3.3.15 + +### 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/api-key-stamper@0.4.7 + +## 3.3.14 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.3 + +## 3.3.13 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.2 + +## 3.3.12 + +### 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 + +## 3.3.11 + +### Patch Changes + +- Updated dependencies [[`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc), [`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a), [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2)]: + - @turnkey/sdk-browser@5.2.0 + - @turnkey/http@3.4.1 + - @turnkey/api-key-stamper@0.4.6 + +## 3.3.10 + +### Patch Changes + +- Updated dependencies [[`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412)]: + - @turnkey/sdk-browser@5.1.0 + +## 3.3.9 + +### Patch Changes + +- Updated dependencies [[`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0)]: + - @turnkey/sdk-browser@5.0.0 + - @turnkey/http@3.4.0 + +## 3.3.8 + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/sdk-browser@4.3.0 + - @turnkey/http@3.3.0 + +## 3.3.7 + +### Patch Changes + +- Updated dependencies [3f6e415] +- Updated dependencies [4d1d775] + - @turnkey/sdk-browser@4.2.0 + - @turnkey/http@3.2.0 + - @turnkey/api-key-stamper@0.4.5 + +## 3.3.6 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/sdk-browser@4.1.0 + - @turnkey/http@3.1.0 + ## 3.3.5 ### Patch Changes @@ -266,4 +470,4 @@ mode: wide ## 0.1.0 -Initial release! +Initial release! \ No newline at end of file diff --git a/generated-docs/changelogs/encoding/readme.mdx b/generated-docs/changelogs/encoding/readme.mdx index c7a420ee6..096eecba3 100644 --- a/generated-docs/changelogs/encoding/readme.mdx +++ b/generated-docs/changelogs/encoding/readme.mdx @@ -2,9 +2,45 @@ title: "Encoding" mode: wide --- - + # @turnkey/encoding +## 0.6.0-beta.4 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +## 0.6.0-beta.3 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +## 0.6.0-beta.2 + +### Minor Changes + +- updating package versions + +## 0.6.0-beta.1 + +### Minor Changes + +- test build + +## 0.6.0-beta.0 + +### Minor Changes + +- beta for @turnkey/react-wallet-kit and @turnkey/core + +## 0.5.0 + +### Minor Changes + +- [#653](https://github.com/tkhq/sdk/pull/653) [`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a) Thanks [@moe-dev](https://github.com/moe-dev)! - Add pointEncode function + ## 0.4.0 ### Minor Changes @@ -31,4 +67,4 @@ mode: wide ## 0.1.0 -Initial release +Initial release \ No newline at end of file diff --git a/generated-docs/changelogs/ethers/readme.mdx b/generated-docs/changelogs/ethers/readme.mdx index 0029c757a..b1f5a8c54 100644 --- a/generated-docs/changelogs/ethers/readme.mdx +++ b/generated-docs/changelogs/ethers/readme.mdx @@ -2,9 +2,238 @@ title: "Ethers" mode: wide --- - + # @turnkey/ethers +## 1.2.8-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.1 + - @turnkey/http@3.10.0-beta.1 + - @turnkey/sdk-browser@5.7.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + +## 1.2.8-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.0 + - @turnkey/http@3.10.0-beta.0 + - @turnkey/sdk-browser@5.7.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + +## 1.2.8-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/sdk-server@4.5.1-beta.2 + +## 1.2.8-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.1 + - @turnkey/http@3.8.1-beta.1 + - @turnkey/sdk-server@4.5.1-beta.1 + +## 1.2.8-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/sdk-server@4.5.1-beta.0 + +## 1.2.8 + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9), [`1a549b7`](https://github.com/tkhq/sdk/commit/1a549b71f9a6e7ab59d52aaae7e58e34c8f2e8b5)]: + - @turnkey/sdk-browser@5.7.0 + - @turnkey/sdk-server@4.6.0 + - @turnkey/http@3.9.0 + +## 1.2.7 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/sdk-browser@5.6.0 + - @turnkey/sdk-server@4.5.0 + - @turnkey/http@3.8.0 + +## 1.2.6 + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed)]: + - @turnkey/http@3.7.0 + - @turnkey/sdk-browser@5.5.0 + - @turnkey/sdk-server@4.4.0 + +## 1.2.5 + +### Patch Changes + +- Updated dependencies [[`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15)]: + - @turnkey/sdk-browser@5.4.1 + +## 1.2.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 + +## 1.2.3 + +### Patch Changes + +- Updated dependencies [[`2db00b0`](https://github.com/tkhq/sdk/commit/2db00b0a799d09ae33fa08a117e3b2f433f2b0b4)]: + - @turnkey/sdk-server@4.2.4 + +## 1.2.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 + +## 1.2.1 + +### Patch Changes + +- Updated dependencies [[`2c4f42c`](https://github.com/tkhq/sdk/commit/2c4f42c747ac8017cf17e86b0ca0c3fa6f593bbf)]: + - @turnkey/sdk-browser@5.3.3 + +## 1.2.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. + +## 1.1.34 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.3.2 + - @turnkey/sdk-server@4.2.2 + +## 1.1.33 + +### Patch Changes + +- Updated dependencies [[`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]: + - @turnkey/sdk-browser@5.3.1 + - @turnkey/sdk-server@4.2.1 + +## 1.1.32 + +### 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 + +## 1.1.31 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.3 + +## 1.1.30 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.2 + +## 1.1.29 + +### 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 + +## 1.1.28 + +### 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 + +## 1.1.27 + +### Patch Changes + +- Updated dependencies [[`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412)]: + - @turnkey/sdk-browser@5.1.0 + - @turnkey/sdk-server@4.0.1 + +## 1.1.26 + +### 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 + +## 1.1.25 + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/sdk-browser@4.3.0 + - @turnkey/sdk-server@3.3.0 + - @turnkey/http@3.3.0 + +## 1.1.24 + +### 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 + +## 1.1.23 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/sdk-browser@4.1.0 + - @turnkey/sdk-server@3.1.0 + - @turnkey/http@3.1.0 + ## 1.1.22 ### Patch Changes @@ -926,4 +1155,4 @@ const turnkeySigner = new TurnkeySigner({ - Initial release - Updated dependencies - - @turnkey/http@0.1.1 + - @turnkey/http@0.1.1 \ No newline at end of file diff --git a/generated-docs/changelogs/http/readme.mdx b/generated-docs/changelogs/http/readme.mdx index c18745012..893e14fb8 100644 --- a/generated-docs/changelogs/http/readme.mdx +++ b/generated-docs/changelogs/http/readme.mdx @@ -2,9 +2,162 @@ title: "Http" mode: wide --- - + # @turnkey/http +## 3.10.0-beta.1 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.4 + - @turnkey/api-key-stamper@0.4.8-beta.4 + +## 3.10.0-beta.0 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.3 + - @turnkey/api-key-stamper@0.4.8-beta.3 + +## 3.9.0 + +### Minor Changes + +- [#834](https://github.com/tkhq/sdk/pull/834) [`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9) Author [@moeodeh3](https://github.com/moeodeh3) - Update per mono release v2025.8.3-hotfix.0 + +## 3.8.1-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + +## 3.8.1-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.1 + +## 3.8.1-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@1.0.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + +## 3.8.0 + +### Minor Changes + +- [#826](https://github.com/tkhq/sdk/pull/826) [`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0) Author [@turnekybc](https://github.com/turnekybc) - Update per mono release v2025.8.1 + +## 3.7.0 + +### Minor Changes + +- [#651](https://github.com/tkhq/sdk/pull/651) [`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed) Author [@turnekybc](https://github.com/turnekybc) - Add Coinbase & MoonPay Fiat Onramp. View the [Fiat Onramp feature docs](https://docs.turnkey.com/wallets/fiat-on-ramp). + +## 3.6.0 + +### Minor Changes + +- [#782](https://github.com/tkhq/sdk/pull/782) [`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e) Thanks [@r-n-o](https://github.com/r-n-o)! - Release v2025.7.16 + +## 3.5.1 + +### Patch Changes + +- [#763](https://github.com/tkhq/sdk/pull/763) [`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a) Author [@andrewkmin](https://github.com/andrewkmin) - Release per mono v2025.7.1. This release contains the following API changes: + + - Introduction of `SmartContractInterfaces`: we've now exposed endpoints for uploading ABIs and IDLs to help secure EVM and Solana signing flows. For more information, see our docs [here](https://docs.turnkey.com/concepts/policies/smart-contract-interfaces) + +## 3.5.0 + +### Minor Changes + +- [#704](https://github.com/tkhq/sdk/pull/704) [`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd) Author [@amircheikh](https://github.com/amircheikh) - Added `name` field to constructor. `isHttpClient` now uses this new field to complete the check. This fixes a bug where `isHttpClient` would fail the check under certain production environments. + + Synced with mono 2025.6.10 to include the following endpoints: + + `update_user_email`: Update a User's email in an existing Organization + + `update_user_name`: Update a User's name in an existing Organization + + `update_user_phone_number`: Update a User's phone number in an existing Organization + +### Patch Changes + +- Updated dependencies [[`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164)]: + - @turnkey/api-key-stamper@0.4.7 + +## 3.4.2 + +### Patch Changes + +- [#665](https://github.com/tkhq/sdk/pull/665) [`be0a621`](https://github.com/tkhq/sdk/commit/be0a621fb962bd51d2df1a1e79f5260d7c696772) Author [@amircheikh](https://github.com/amircheikh) - Exposed `isHttpClient` function for determining if a passed in client is from turnkey/http + +## 3.4.1 + +### Patch Changes + +- [#663](https://github.com/tkhq/sdk/pull/663) [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2) Thanks [@moe-dev](https://github.com/moe-dev)! - Update to endpoints as per mono v2025.5.7. Add V5 TON address format generation. Non breaking + +- Updated dependencies [[`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc), [`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a)]: + - @turnkey/webauthn-stamper@0.5.1 + - @turnkey/encoding@0.5.0 + - @turnkey/api-key-stamper@0.4.6 + +## 3.4.0 + +### Minor Changes + +- Added new authentication activities: + - STAMP_LOGIN: Handles authentication flows for passkeys, wallet logins, and session refresh. Initiated by sub-organizations; returns a session JWT. + - INIT_OTP: Initiates sending a 6–9 digit or bech32 alphanumeric OTP to an email or phone. Initiated by the parent organization. + - VERIFY_OTP: Verifies the OTP and returns a verification token. Initiated by the parent organization. + - OTP_LOGIN: Completes OTP-based authentication by verifying a tokenized OTP challenge and establishing a session. Initiated by the parent organization; returns a session JWT. + - OAUTH_LOGIN: Finalizes OAuth-based logins from third-party OIDC providers. Initiated by the parent organization; returns a session JWT. + +## 3.3.0 + +### Minor Changes + +- 25ca339: Adding replyToEmailAddress field for specifying reply-to when using a customer sender + +## 3.2.0 + +### Minor Changes + +- 3f6e415: Update per mono v2025.4.5 + - Introduces Tron transaction parsing and policy engine support. For more information, take a look at our [docs](https://docs.turnkey.com/networks/tron) + +### Patch Changes + +- Updated dependencies [4d1d775] + - @turnkey/api-key-stamper@0.4.5 + +## 3.1.0 + +### Minor Changes + +- 3e4a482: Release per mono v2025.4.4 + - Adds parsing and policy engine support for Ethereum Type 3 (EIP-4844) and Type 4 (EIP-7702) transactions. There is no change to any signing interface or API; you simply can now use Turnkey's signing endpoints to sign those transaction types. See [with-viem](https://github.com/tkhq/sdk/blob/main/examples/with-viem/) for examples. + - New wallet account creations will now automatically derive the underlying derived account's public key. For example: previously, if derived an Ethereum wallet account, you would get the resulting Ethereum address (`0x...`). If you also wanted the public key associated with that underlying key, you would've had to derive an additional wallet account with `ADDRESS_FORMAT_COMPRESSED`. Now, this will automatically be derived for you. It is now a property that has been added to the wallet account primitive (i.e. accessible via `walletAccount.publicKey`). + ## 3.0.0 ### Major Changes @@ -632,4 +785,4 @@ Signing is now performed through Turnkey stampers. New dependencies: - Initial release - Updated dependencies - - @turnkey/jest-config@0.1.1 + - @turnkey/jest-config@0.1.1 \ No newline at end of file diff --git a/generated-docs/changelogs/iframe-stamper/readme.mdx b/generated-docs/changelogs/iframe-stamper/readme.mdx index 65db19e23..361d747f6 100644 --- a/generated-docs/changelogs/iframe-stamper/readme.mdx +++ b/generated-docs/changelogs/iframe-stamper/readme.mdx @@ -2,7 +2,7 @@ title: "Iframe Stamper" mode: wide --- - + # @turnkey/iframe-stamper ## 2.5.0 @@ -108,4 +108,4 @@ mode: wide ## 0.1.0 -Initial release +Initial release \ No newline at end of file diff --git a/generated-docs/changelogs/react-native-passkey-stamper/readme.mdx b/generated-docs/changelogs/react-native-passkey-stamper/readme.mdx index e2325d559..66f0b6f83 100644 --- a/generated-docs/changelogs/react-native-passkey-stamper/readme.mdx +++ b/generated-docs/changelogs/react-native-passkey-stamper/readme.mdx @@ -2,9 +2,138 @@ title: "React Native Passkey Stamper" mode: wide --- - + # @turnkey/react-native-passkey-stamper +## 1.1.2-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.4 + - @turnkey/http@3.10.0-beta.1 + +## 1.1.2-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.3 + - @turnkey/http@3.10.0-beta.0 + +## 1.1.2-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.2 + - @turnkey/http@3.8.1-beta.2 + +## 1.1.2-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.1 + - @turnkey/http@3.8.1-beta.1 + +## 1.1.2-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@1.0.0-beta.0 + - @turnkey/http@3.8.1-beta.0 + +## 1.1.2 + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9)]: + - @turnkey/http@3.9.0 + +## 1.1.1 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/http@3.8.0 + +## 1.1.0 + +### Minor Changes + +- [#651](https://github.com/tkhq/sdk/pull/651) [`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed) Author [@turnekybc](https://github.com/turnekybc) - Add Coinbase & MoonPay Fiat Onramp. View the [Fiat Onramp feature docs](https://docs.turnkey.com/wallets/fiat-on-ramp). + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed)]: + - @turnkey/http@3.7.0 + +## 1.0.19 + +### Patch Changes + +- Updated dependencies [[`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e)]: + - @turnkey/http@3.6.0 + +## 1.0.18 + +### Patch Changes + +- Updated dependencies [[`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a)]: + - @turnkey/http@3.5.1 + +## 1.0.17 + +### Patch Changes + +- Updated dependencies [[`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd)]: + - @turnkey/http@3.5.0 + +## 1.0.16 + +### Patch Changes + +- Updated dependencies [[`be0a621`](https://github.com/tkhq/sdk/commit/be0a621fb962bd51d2df1a1e79f5260d7c696772)]: + - @turnkey/http@3.4.2 + +## 1.0.15 + +### Patch Changes + +- Updated dependencies [[`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a), [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2)]: + - @turnkey/encoding@0.5.0 + - @turnkey/http@3.4.1 + +## 1.0.14 + +### Patch Changes + +- Updated dependencies [[`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0)]: + - @turnkey/http@3.4.0 + +## 1.0.13 + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/http@3.3.0 + +## 1.0.12 + +### Patch Changes + +- Updated dependencies [3f6e415] + - @turnkey/http@3.2.0 + +## 1.0.11 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/http@3.1.0 + ## 1.0.10 ### Patch Changes @@ -211,4 +340,4 @@ This is a major change because the `transports` property, previously a string ar ## 0.1.0 -Initial release +Initial release \ No newline at end of file diff --git a/generated-docs/changelogs/react-wallet-kit/readme.mdx b/generated-docs/changelogs/react-wallet-kit/readme.mdx new file mode 100644 index 000000000..8ec7ed473 --- /dev/null +++ b/generated-docs/changelogs/react-wallet-kit/readme.mdx @@ -0,0 +1,90 @@ +--- +title: "React Wallet Kit" +mode: wide +--- + +# @turnkey/react-wallet-kit + +## 1.0.0-beta.4 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.4 + - @turnkey/core@1.0.0-beta.4 + +## 1.0.0-beta.3 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.3 + - @turnkey/core@1.0.0-beta.3 + +## 1.0.0-beta.2 + +### Minor Changes + +- updating package versions + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.2 + - @turnkey/core@1.0.0-beta.2 + +## 1.0.0-beta.1 + +### Minor Changes + +- test build + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.1 + - @turnkey/core@1.0.0-beta.1 + +## 1.0.0-beta.0 + +### Major Changes + +- beta for @turnkey/react-wallet-kit and @turnkey/core + +### Patch Changes + +- Updated dependencies []: + - @turnkey/core@1.0.0-beta.0 + - @turnkey/sdk-types@0.4.0-beta.0 + +## 1.0.0 + +### Major Changes + +- Initial beta release for react wallet kit + +### Patch Changes + +- Updated dependencies []: + - @turnkey/core@1.0.0 + - @turnkey/sdk-types@0.4.0 + +## 1.0.0 + +### Major Changes + +- Initial beta release for @turnkey/react-wallet-kit and @turnkey/core + +### Patch Changes + +- Updated dependencies []: + - @turnkey/core@1.0.0 + - @turnkey/sdk-types@0.4.0 \ No newline at end of file diff --git a/generated-docs/changelogs/sdk-browser/readme.mdx b/generated-docs/changelogs/sdk-browser/readme.mdx index 1771490e5..50d239b65 100644 --- a/generated-docs/changelogs/sdk-browser/readme.mdx +++ b/generated-docs/changelogs/sdk-browser/readme.mdx @@ -2,9 +2,308 @@ title: "SDK Browser" mode: wide --- - + # @turnkey/sdk-browser +## 5.7.1-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.4 + - @turnkey/encoding@0.6.0-beta.4 + - @turnkey/http@3.10.0-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + - @turnkey/crypto@2.5.1-beta.4 + - @turnkey/indexed-db-stamper@1.1.2-beta.4 + - @turnkey/wallet-stamper@1.0.9-beta.4 + +## 5.7.1-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.3 + - @turnkey/encoding@0.6.0-beta.3 + - @turnkey/http@3.10.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + - @turnkey/crypto@2.5.1-beta.3 + - @turnkey/indexed-db-stamper@1.1.2-beta.3 + - @turnkey/wallet-stamper@1.0.9-beta.3 + +## 5.7.0 + +### Minor Changes + +- [#834](https://github.com/tkhq/sdk/pull/834) [`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9) Author [@moeodeh3](https://github.com/moeodeh3) - Update per mono release v2025.8.3-hotfix.0 + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9)]: + - @turnkey/http@3.9.0 + - @turnkey/crypto@2.5.0 + - @turnkey/wallet-stamper@1.0.8 + +## 5.6.1-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.2 + - @turnkey/encoding@0.6.0-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/crypto@2.5.1-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/indexed-db-stamper@1.1.2-beta.2 + - @turnkey/wallet-stamper@1.0.9-beta.2 + +## 5.6.1-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@1.0.0-beta.0 + - @turnkey/encoding@1.0.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/crypto@2.5.1-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/indexed-db-stamper@1.1.2-beta.0 + - @turnkey/wallet-stamper@1.0.9-beta.0 + +## 5.6.0 + +### Minor Changes + +- [#826](https://github.com/tkhq/sdk/pull/826) [`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0) Author [@turnekybc](https://github.com/turnekybc) - Update per mono release v2025.8.1 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/http@3.8.0 + - @turnkey/crypto@2.5.0 + - @turnkey/wallet-stamper@1.0.8 + +## 5.5.0 + +### Minor Changes + +- [#651](https://github.com/tkhq/sdk/pull/651) [`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed) Author [@turnekybc](https://github.com/turnekybc) - Add Coinbase & MoonPay Fiat Onramp. View the [Fiat Onramp feature docs](https://docs.turnkey.com/wallets/fiat-on-ramp). + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed), [`6cde41c`](https://github.com/tkhq/sdk/commit/6cde41cfecdfb7d54abf52cc65e28ef0e2ad6ba3)]: + - @turnkey/http@3.7.0 + - @turnkey/sdk-types@0.3.0 + - @turnkey/crypto@2.5.0 + - @turnkey/wallet-stamper@1.0.8 + +## 5.4.1 + +### Patch Changes + +- [#787](https://github.com/tkhq/sdk/pull/787) [`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15) Author [@andrewkmin](https://github.com/andrewkmin) - Add optional `organizationId` parameter to `loginWithPasskey()` and `loginWithWallet()` to allow targeting a specific organization. + +## 5.4.0 + +### Minor Changes + +- [#782](https://github.com/tkhq/sdk/pull/782) [`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e) Thanks [@r-n-o](https://github.com/r-n-o)! - Release v2025.7.16 + +### Patch Changes + +- Updated dependencies [[`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e)]: + - @turnkey/http@3.6.0 + - @turnkey/crypto@2.4.3 + - @turnkey/wallet-stamper@1.0.7 + +## 5.3.4 + +### Patch Changes + +- [#763](https://github.com/tkhq/sdk/pull/763) [`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a) Author [@andrewkmin](https://github.com/andrewkmin) - Release per mono v2025.7.1. This release contains the following API changes: + + - Introduction of `SmartContractInterfaces`: we've now exposed endpoints for uploading ABIs and IDLs to help secure EVM and Solana signing flows. For more information, see our docs [here](https://docs.turnkey.com/concepts/policies/smart-contract-interfaces) + +- Updated dependencies [[`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a)]: + - @turnkey/http@3.5.1 + - @turnkey/crypto@2.4.3 + - @turnkey/wallet-stamper@1.0.7 + +## 5.3.3 + +### Patch Changes + +- [#750](https://github.com/tkhq/sdk/pull/750) [`2c4f42c`](https://github.com/tkhq/sdk/commit/2c4f42c747ac8017cf17e86b0ca0c3fa6f593bbf) Thanks [@moe-dev](https://github.com/moe-dev)! - Surface keyFormat for extractKeyEncryptedBundle in iframe client abstraction + +## 5.3.2 + +### Patch Changes + +- Updated dependencies [[`6cbff7a`](https://github.com/tkhq/sdk/commit/6cbff7a0c0b3a9a05586399e5cef476154d3bdca)]: + - @turnkey/crypto@2.4.3 + - @turnkey/wallet-stamper@1.0.7 + +## 5.3.1 + +### Patch Changes + +- [#716](https://github.com/tkhq/sdk/pull/716) [`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79) Author [@moeodeh3](https://github.com/moeodeh3) - Updated dependencies + + - bs58check@4.0.0 + +- Updated dependencies [[`c5cdf82`](https://github.com/tkhq/sdk/commit/c5cdf8229da5da1bd6d52db06b2fe42826e96d57), [`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]: + - @turnkey/crypto@2.4.2 + - @turnkey/wallet-stamper@1.0.6 + +## 5.3.0 + +### Minor Changes + +- [#704](https://github.com/tkhq/sdk/pull/704) [`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd) Author [@amircheikh](https://github.com/amircheikh) - Synced with mono 2025.6.10 to include the following endpoints: + + `update_user_email`: Update a User's email in an existing Organization + + `update_user_name`: Update a User's name in an existing Organization + + `update_user_phone_number`: Update a User's phone number in an existing Organization + +### Patch Changes + +- Updated dependencies [[`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd), [`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164), [`878e039`](https://github.com/tkhq/sdk/commit/878e03973856cfec83e6e3fda5b76d1b64943628)]: + - @turnkey/http@3.5.0 + - @turnkey/api-key-stamper@0.4.7 + - @turnkey/crypto@2.4.1 + - @turnkey/wallet-stamper@1.0.5 + - @turnkey/indexed-db-stamper@1.1.1 + +## 5.2.3 + +### Patch Changes + +- Updated dependencies [[`039602a`](https://github.com/tkhq/sdk/commit/039602a015d20783952b992d1d339f5fc003f658)]: + - @turnkey/sdk-types@0.2.1 + +## 5.2.2 + +### Patch Changes + +- Updated dependencies [[`0dd3fc3`](https://github.com/tkhq/sdk/commit/0dd3fc31956992c5b449da5868f6eef8b0bb194c)]: + - @turnkey/sdk-types@0.2.0 + +## 5.2.1 + +### Patch Changes + +- Updated dependencies [[`be0a621`](https://github.com/tkhq/sdk/commit/be0a621fb962bd51d2df1a1e79f5260d7c696772)]: + - @turnkey/http@3.4.2 + - @turnkey/crypto@2.4.0 + - @turnkey/wallet-stamper@1.0.4 + +## 5.2.0 + +### Minor Changes + +- [#659](https://github.com/tkhq/sdk/pull/659) [`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc) Author [@turnekybc](https://github.com/turnekybc) - export types and models from @turnkey/sdk-browser + +### Patch Changes + +- [#653](https://github.com/tkhq/sdk/pull/653) [`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a) Thanks [@moe-dev](https://github.com/moe-dev)! - Allow external keys to be passed to resetKeyPair in the indexedDbClient/Stamper enabling refreshing RW sessions + +- [#663](https://github.com/tkhq/sdk/pull/663) [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2) Thanks [@moe-dev](https://github.com/moe-dev)! - Update to endpoints as per mono v2025.5.7. Add V5 TON address format generation. Non breaking + +- Updated dependencies [[`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc), [`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a), [`10ee5c5`](https://github.com/tkhq/sdk/commit/10ee5c524b477ce998e4fc635152cd101ae5a9cc), [`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a), [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2)]: + - @turnkey/wallet-stamper@1.0.4 + - @turnkey/webauthn-stamper@0.5.1 + - @turnkey/encoding@0.5.0 + - @turnkey/crypto@2.4.0 + - @turnkey/indexed-db-stamper@1.1.0 + - @turnkey/http@3.4.1 + - @turnkey/api-key-stamper@0.4.6 + +## 5.1.0 + +### Minor Changes + +- Update @turnkey/sdk-types readme and install dependency in packages with common types + +- [#650](https://github.com/tkhq/sdk/pull/650) [`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412) Author [@turnekybc](https://github.com/turnekybc) - Update @turnkey/sdk-types readme and install dependency in packages with common types + +### Patch Changes + +- Updated dependencies [[`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412)]: + - @turnkey/sdk-types@0.1.0 + +## 5.0.0 + +### Major Changes + +- [#601](https://github.com/tkhq/sdk/pull/601) [`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0) Author [@moe-dev](https://github.com/moe-dev) + +This release introduces the new `indexedDbClient`, leveraging the `indexedDbStamper` to securely store cryptographic keys directly in IndexedDB. It provides persistent, secure, non-extractable authentication, replacing legacy iframe-based flows for OTP, passkey, external wallet, and OAuth authentications. + +### Key Changes: + +- **IndexedDB Client (`indexedDbClient`)**: + + - Offers persistent, tamper-resistant authentication using P-256 keys stored securely in IndexedDB. + - Eliminates the need for credential injection via iframes, significantly improving the DevEx and UX of session management. + - Provides human-readable sessions through `getSession()`. + +- **Deprecation Notice**: + - Authentication via the `iframeClient` (e.g., `auth.turnkey.com`) is deprecated. Developers should migrate authentication flows to the new IndexedDB-based client. + - Existing iframe-based wallet flows (Email Recovery, Import, and Export) remain supported. + +These enhancements simplify integrations, improve UX, and deliver a more robust client-side experience. + +### Patch Changes + +- Updated dependencies [[`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0)]: + - @turnkey/indexed-db-stamper@1.0.0 + - @turnkey/http@3.4.0 + - @turnkey/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + +## 4.3.0 + +### Minor Changes + +- 25ca339: Adding replyToEmailAddress field for specifying reply-to when using a customer sender + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/http@3.3.0 + - @turnkey/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + +## 4.2.0 + +### Minor Changes + +- 3f6e415: Update per mono v2025.4.5 + +### Patch Changes + +- Updated dependencies [3f6e415] +- Updated dependencies [4d1d775] + - @turnkey/http@3.2.0 + - @turnkey/api-key-stamper@0.4.5 + - @turnkey/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + +## 4.1.0 + +### Minor Changes + +- 3e4a482: Release per mono v2025.4.4 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/http@3.1.0 + - @turnkey/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + ## 4.0.0 ### Major Changes @@ -591,4 +890,4 @@ mode: wide ## 0.0.1 -Initial (experimental) release! This is an alpha release and subject to change. +Initial (experimental) release! This is an alpha release and subject to change. \ No newline at end of file diff --git a/generated-docs/changelogs/sdk-react-native/readme.mdx b/generated-docs/changelogs/sdk-react-native/readme.mdx index 81891b519..24ed70086 100644 --- a/generated-docs/changelogs/sdk-react-native/readme.mdx +++ b/generated-docs/changelogs/sdk-react-native/readme.mdx @@ -2,9 +2,254 @@ title: "SDK React Native" mode: wide --- - + # @turnkey/sdk-react-native +## 1.4.2-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.4 + - @turnkey/http@3.10.0-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + - @turnkey/crypto@2.5.1-beta.4 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.4 + +## 1.4.2-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.3 + - @turnkey/http@3.10.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + - @turnkey/crypto@2.5.1-beta.3 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.3 + +## 1.4.2-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/crypto@2.5.1-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.2 + +## 1.4.2-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.1 + - @turnkey/crypto@2.5.1-beta.1 + - @turnkey/http@3.8.1-beta.1 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.1 + +## 1.4.2-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@1.0.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/crypto@2.5.1-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/react-native-passkey-stamper@1.1.2-beta.0 + +## 1.4.2 + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9)]: + - @turnkey/http@3.9.0 + - @turnkey/crypto@2.5.0 + - @turnkey/react-native-passkey-stamper@1.1.2 + +## 1.4.1 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/http@3.8.0 + - @turnkey/crypto@2.5.0 + - @turnkey/react-native-passkey-stamper@1.1.1 + +## 1.4.0 + +### Minor Changes + +- [#651](https://github.com/tkhq/sdk/pull/651) [`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed) Author [@turnekybc](https://github.com/turnekybc) - Add Coinbase & MoonPay Fiat Onramp. View the [Fiat Onramp feature docs](https://docs.turnkey.com/wallets/fiat-on-ramp). + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed), [`6cde41c`](https://github.com/tkhq/sdk/commit/6cde41cfecdfb7d54abf52cc65e28ef0e2ad6ba3)]: + - @turnkey/react-native-passkey-stamper@1.1.0 + - @turnkey/http@3.7.0 + - @turnkey/crypto@2.5.0 + +## 1.3.7 + +### Patch Changes + +- Updated dependencies [[`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e)]: + - @turnkey/http@3.6.0 + - @turnkey/crypto@2.4.3 + - @turnkey/react-native-passkey-stamper@1.0.19 + +## 1.3.6 + +### Patch Changes + +- Updated dependencies [[`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a)]: + - @turnkey/http@3.5.1 + - @turnkey/crypto@2.4.3 + - @turnkey/react-native-passkey-stamper@1.0.18 + +## 1.3.5 + +### Patch Changes + +- Updated dependencies [[`6cbff7a`](https://github.com/tkhq/sdk/commit/6cbff7a0c0b3a9a05586399e5cef476154d3bdca)]: + - @turnkey/crypto@2.4.3 + +## 1.3.4 + +### Patch Changes + +- [#711](https://github.com/tkhq/sdk/pull/711) [`22dc1aa`](https://github.com/tkhq/sdk/commit/22dc1aa3f289ddc5818fb7328235eaa873f8f367) Author [@moeodeh3](https://github.com/moeodeh3) - Added `onInitialized`. A callback function that runs when context initialization is complete, useful for notifying connected apps. + +- Updated dependencies [[`c5cdf82`](https://github.com/tkhq/sdk/commit/c5cdf8229da5da1bd6d52db06b2fe42826e96d57), [`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]: + - @turnkey/crypto@2.4.2 + +## 1.3.3 + +### Patch Changes + +- Updated dependencies [[`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd), [`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164), [`878e039`](https://github.com/tkhq/sdk/commit/878e03973856cfec83e6e3fda5b76d1b64943628)]: + - @turnkey/http@3.5.0 + - @turnkey/api-key-stamper@0.4.7 + - @turnkey/crypto@2.4.1 + - @turnkey/react-native-passkey-stamper@1.0.17 + +## 1.3.2 + +### Patch Changes + +- Updated dependencies [[`be0a621`](https://github.com/tkhq/sdk/commit/be0a621fb962bd51d2df1a1e79f5260d7c696772)]: + - @turnkey/http@3.4.2 + - @turnkey/crypto@2.4.0 + - @turnkey/react-native-passkey-stamper@1.0.16 + +## 1.3.1 + +### Patch Changes + +- Updated dependencies [[`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a), [`10ee5c5`](https://github.com/tkhq/sdk/commit/10ee5c524b477ce998e4fc635152cd101ae5a9cc), [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2)]: + - @turnkey/encoding@0.5.0 + - @turnkey/crypto@2.4.0 + - @turnkey/http@3.4.1 + - @turnkey/api-key-stamper@0.4.6 + - @turnkey/react-native-passkey-stamper@1.0.15 + +## 1.3.0 + +### Minor Changes + +- [#622](https://github.com/tkhq/sdk/pull/622) [`59f8941`](https://github.com/tkhq/sdk/commit/59f8941f77e548e248b2fdafcad36f5f0c2a5d29) Author [@moeodeh3](https://github.com/moeodeh3) - Added support for React 19 + + Renamed `sessionKey` parameter to `storageKey` in `createEmbeddedKey` `saveEmbeddedKey` and `getEmbeddedKey`. + + Added optional `embeddedStorageKey` parameter to `createSession`. This allows for retrieval of the embedded key from a custom location in secure storage. + +### Patch Changes + +- [#641](https://github.com/tkhq/sdk/pull/641) [`77611c8`](https://github.com/tkhq/sdk/commit/77611c8f15aa16b316d81ee6addab62d86f2f3bc) Author [@amircheikh](https://github.com/amircheikh) - Added `onSessionEmpty`. A callback function that runs when there is no active session on app launch. + +- Updated dependencies [[`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0)]: + - @turnkey/http@3.4.0 + - @turnkey/crypto@2.3.1 + - @turnkey/react-native-passkey-stamper@1.0.14 + +## 1.2.3 + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/http@3.3.0 + - @turnkey/crypto@2.3.1 + - @turnkey/react-native-passkey-stamper@1.0.13 + +## 1.2.2 + +### Patch Changes + +- ef399e1: - Eliminated a race condition in `refreshSession` that could throw: + `TurnkeyReactNativeError: Embedded key not found when refreshing the session` + + - The embedded key is now generated entirely in memory using `generateP256KeyPair` + - Removed the need to store and immediately retrieve the private key from secure storage + - `refreshSession` now accepts a single optional parameter object + - `StorageKeys.RefreshEmbeddedKey` is now deprecated and no longer used during session refresh + +- Updated dependencies [3f6e415] +- Updated dependencies [4d1d775] + - @turnkey/http@3.2.0 + - @turnkey/api-key-stamper@0.4.5 + - @turnkey/crypto@2.3.1 + - @turnkey/react-native-passkey-stamper@1.0.12 + +## 1.2.1 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/http@3.1.0 + - @turnkey/crypto@2.3.1 + - @turnkey/react-native-passkey-stamper@1.0.11 + +## 1.2.0 + +### Minor Changes + +- ab45d29: Added `createSessionFromEmbeddedKey` function. This allows creation of a session using a compressed embedded key stored by calling `createEmbeddedKey`. You may also optionally pass in an embedded key created seperately. Utilizing these two functions with a `createSuborg` api call allows for a '1 tap' passkey sign up flow [(example)](https://github.com/tkhq/react-native-demo-wallet/blob/ccf2d6c182b9e5c5ce98014a56b0b9f4282277c2/providers/auth-provider.tsx#L186). + + Added optional `isCompressed` boolean field to the `createEmbeddedKey` function. This field is necessary for calling `createSessionFromEmbeddedKey`. + +## 1.1.0 + +### Minor Changes + +- e8bc05b: Introduces handleGoogleOAuth(): Adds a utility function to handle the Google OAuth authentication flow in React Native. + +**Usage Summary**: +`handleGoogleOAuth` launches an InAppBrowser to initiate the OAuth flow using your client ID, nonce, and app scheme. After a successful login, it extracts the `oidcToken` from the redirect URL and calls your `onSuccess` callback with the token. + +```ts +handleGoogleOAuth({ + clientId: string, // Google OAuth client ID + nonce: string, // Random nonce + scheme: string, // App’s custom URL scheme (e.g., "myapp") + originUri?: string, // Optional custom origin URI - defaults to Turnkey proxies + redirectUri?: string, // Optional custom redirect URI - defaults to Turnkey proxies + onSuccess: (oidcToken: string) => void, // Called with token on success +}); +``` + +## 1.0.5 + +### Patch Changes + +- 3b5b360: - Adds optional parameter for createEmbeddedKey(): + - You can now pass a sessionKey to createEmbeddedKey() to generate separate embedded keys for different sessions, which is helpful when running multiple authentication flows concurrently. + - Introduces onSessionExpiryWarning(): + - You can now add a callback via the provider config that triggers 15 seconds before a session expires. + - Introduces refreshSession(): + - You now can refresh an active session that is about to expire. + ## 1.0.4 ### Patch Changes @@ -56,4 +301,4 @@ mode: wide - Updated dependencies [3c44c4a] - @turnkey/http@2.20.0 - - @turnkey/crypto@2.3.1 + - @turnkey/crypto@2.3.1 \ No newline at end of file diff --git a/generated-docs/changelogs/sdk-react/readme.mdx b/generated-docs/changelogs/sdk-react/readme.mdx index 796c51f0b..b72ac01c6 100644 --- a/generated-docs/changelogs/sdk-react/readme.mdx +++ b/generated-docs/changelogs/sdk-react/readme.mdx @@ -2,9 +2,319 @@ title: "SDK React" mode: wide --- - + # @turnkey/sdk-react +## 5.4.0-beta.4 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.1 + - @turnkey/sdk-types@0.4.0-beta.4 + - @turnkey/sdk-browser@5.7.1-beta.1 + - @turnkey/crypto@2.5.1-beta.4 + - @turnkey/wallet-stamper@1.0.9-beta.4 + +## 5.4.0-beta.3 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.0 + - @turnkey/sdk-types@0.4.0-beta.3 + - @turnkey/sdk-browser@5.7.1-beta.0 + - @turnkey/crypto@2.5.1-beta.3 + - @turnkey/wallet-stamper@1.0.9-beta.3 + +## 5.3.2-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.2 + - @turnkey/sdk-browser@5.6.1-beta.2 + - @turnkey/crypto@2.5.1-beta.2 + - @turnkey/wallet-stamper@1.0.9-beta.2 + - @turnkey/sdk-server@4.5.1-beta.2 + +## 5.3.2-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@0.4.0-beta.1 + - @turnkey/sdk-browser@5.6.1-beta.1 + - @turnkey/crypto@2.5.1-beta.1 + - @turnkey/wallet-stamper@1.0.9-beta.1 + - @turnkey/sdk-server@4.5.1-beta.1 + +## 5.3.2-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-types@1.0.0-beta.0 + - @turnkey/sdk-browser@5.6.1-beta.0 + - @turnkey/crypto@2.5.1-beta.0 + - @turnkey/wallet-stamper@1.0.9-beta.0 + - @turnkey/sdk-server@4.5.1-beta.0 + +## 5.3.2 + +### Patch Changes + +- [#833](https://github.com/tkhq/sdk/pull/833) [`1a549b7`](https://github.com/tkhq/sdk/commit/1a549b71f9a6e7ab59d52aaae7e58e34c8f2e8b5) Author [@moeodeh3](https://github.com/moeodeh3) - - Add optional `includeUnverifiedSubOrgs` to `otpConfig` in the Auth component to allow inclusion of unverified subOrgs + - Fix `customAccounts` being ignored for subOrgs created through OTP and external wallets +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9), [`1a549b7`](https://github.com/tkhq/sdk/commit/1a549b71f9a6e7ab59d52aaae7e58e34c8f2e8b5)]: + - @turnkey/sdk-browser@5.7.0 + - @turnkey/sdk-server@4.6.0 + - @turnkey/crypto@2.5.0 + - @turnkey/wallet-stamper@1.0.8 + +## 5.3.1 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/sdk-browser@5.6.0 + - @turnkey/sdk-server@4.5.0 + - @turnkey/crypto@2.5.0 + - @turnkey/wallet-stamper@1.0.8 + +## 5.3.0 + +### Minor Changes + +- [#651](https://github.com/tkhq/sdk/pull/651) [`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed) Author [@turnekybc](https://github.com/turnekybc) - Add Coinbase & MoonPay Fiat Onramp. View the [Fiat Onramp feature docs](https://docs.turnkey.com/wallets/fiat-on-ramp). + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed), [`6cde41c`](https://github.com/tkhq/sdk/commit/6cde41cfecdfb7d54abf52cc65e28ef0e2ad6ba3)]: + - @turnkey/sdk-browser@5.5.0 + - @turnkey/sdk-server@4.4.0 + - @turnkey/sdk-types@0.3.0 + - @turnkey/crypto@2.5.0 + - @turnkey/wallet-stamper@1.0.8 + +## 5.2.11 + +### Patch Changes + +- [#787](https://github.com/tkhq/sdk/pull/787) [`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15) Author [@andrewkmin](https://github.com/andrewkmin) - Add `showTitle` toggle in authConfig for the Auth component to control visibility of the "Log in or Sign up" title. + +- Updated dependencies [[`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15)]: + - @turnkey/sdk-browser@5.4.1 + +## 5.2.10 + +### 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/crypto@2.4.3 + - @turnkey/wallet-stamper@1.0.7 + +## 5.2.9 + +### Patch Changes + +- Updated dependencies [[`2db00b0`](https://github.com/tkhq/sdk/commit/2db00b0a799d09ae33fa08a117e3b2f433f2b0b4)]: + - @turnkey/sdk-server@4.2.4 + +## 5.2.8 + +### 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/crypto@2.4.3 + - @turnkey/wallet-stamper@1.0.7 + +## 5.2.7 + +### Patch Changes + +- Updated dependencies [[`2c4f42c`](https://github.com/tkhq/sdk/commit/2c4f42c747ac8017cf17e86b0ca0c3fa6f593bbf)]: + - @turnkey/sdk-browser@5.3.3 + +## 5.2.6 + +### Patch Changes + +- Updated dependencies [[`6cbff7a`](https://github.com/tkhq/sdk/commit/6cbff7a0c0b3a9a05586399e5cef476154d3bdca)]: + - @turnkey/crypto@2.4.3 + - @turnkey/sdk-browser@5.3.2 + - @turnkey/wallet-stamper@1.0.7 + - @turnkey/sdk-server@4.2.2 + +## 5.2.5 + +### Patch Changes + +- Updated dependencies [[`c5cdf82`](https://github.com/tkhq/sdk/commit/c5cdf8229da5da1bd6d52db06b2fe42826e96d57), [`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79), [`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]: + - @turnkey/crypto@2.4.2 + - @turnkey/sdk-browser@5.3.1 + - @turnkey/wallet-stamper@1.0.6 + - @turnkey/sdk-server@4.2.1 + +## 5.2.4 + +### Patch Changes + +- Updated dependencies [[`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd), [`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164), [`878e039`](https://github.com/tkhq/sdk/commit/878e03973856cfec83e6e3fda5b76d1b64943628)]: + - @turnkey/sdk-browser@5.3.0 + - @turnkey/sdk-server@4.2.0 + - @turnkey/crypto@2.4.1 + - @turnkey/wallet-stamper@1.0.5 + +## 5.2.3 + +### Patch Changes + +- Updated dependencies [[`039602a`](https://github.com/tkhq/sdk/commit/039602a015d20783952b992d1d339f5fc003f658)]: + - @turnkey/sdk-types@0.2.1 + - @turnkey/sdk-browser@5.2.3 + +## 5.2.2 + +### Patch Changes + +- Updated dependencies [[`0dd3fc3`](https://github.com/tkhq/sdk/commit/0dd3fc31956992c5b449da5868f6eef8b0bb194c)]: + - @turnkey/sdk-types@0.2.0 + - @turnkey/sdk-browser@5.2.2 + +## 5.2.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/crypto@2.4.0 + - @turnkey/sdk-browser@5.2.1 + - @turnkey/sdk-server@4.1.1 + - @turnkey/wallet-stamper@1.0.4 + +## 5.2.0 + +### Minor Changes + +- [#632](https://github.com/tkhq/sdk/pull/632) [`a38a6e3`](https://github.com/tkhq/sdk/commit/a38a6e36dc2bf9abdea64bc817d1cad95b8a289a) Author [@amircheikh](https://github.com/amircheikh) - Added optional `socialLinking` boolean to the `authConfig`. If true, this will enable social linking for new Google <-> Gmail users. For more information on social linking, visit [our docs](https://docs.turnkey.com/authentication/social-logins#social-linking). + +### Patch Changes + +- Updated dependencies [[`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc), [`10ee5c5`](https://github.com/tkhq/sdk/commit/10ee5c524b477ce998e4fc635152cd101ae5a9cc), [`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/wallet-stamper@1.0.4 + - @turnkey/crypto@2.4.0 + - @turnkey/sdk-server@4.1.0 + +## 5.1.0 + +### Minor Changes + +- Update @turnkey/sdk-types readme and install dependency in packages with common types + +- [#650](https://github.com/tkhq/sdk/pull/650) [`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412) Author [@turnekybc](https://github.com/turnekybc) - Update @turnkey/sdk-types readme and install dependency in packages with common types + +### Patch Changes + +- Updated dependencies [[`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412)]: + - @turnkey/sdk-browser@5.1.0 + - @turnkey/sdk-types@0.1.0 + - @turnkey/sdk-server@4.0.1 + +## 5.0.2 + +### Patch Changes + +- [#648](https://github.com/tkhq/sdk/pull/648) [`fd2eb18`](https://github.com/tkhq/sdk/commit/fd2eb18afd7a1338f584eda65962f9880eea7092) Thanks [@moe-dev](https://github.com/moe-dev)! - Patch fix for inpage oauth on EWK sometimes failing with Google + +## 5.0.1 + +### Patch Changes + +- [#646](https://github.com/tkhq/sdk/pull/646) [`c6754f2`](https://github.com/tkhq/sdk/commit/c6754f29cce16f0d4451e380742f581a2bf55e77) Thanks [@moe-dev](https://github.com/moe-dev)! - Patch releases fixes Google Oauth edge case in the Auth Component where logins fail due to indexedDbPublic key not being available yet + +## 5.0.0 + +### Major Changes + +- [#601](https://github.com/tkhq/sdk/pull/601) [`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0) Author [@moe-dev](https://github.com/moe-dev) + +This release significantly enhances authentication by integrating the new `indexedDbClient` within the `useTurnkey` hook and updating the `Auth` component to leverage IndexedDB for secure, persistent client-side authentication. + +### Key Changes: + +- **IndexedDB Authentication**: + + - Replaced the legacy iframe-based authentication with `indexedDbClient` for all authentication flows in the `Auth` component. + - Secure, persistent, non-extractable P-256 keys stored in IndexedDB now provide authentication and session management. + +- **Enhanced Developer Experience**: + - The `useTurnkey` hook now includes direct access to the new `indexedDbClient`. + - Simplified and secure client-side authentication without iframe complexity or credential injection. + +### Deprecation Notice: + +- The `iframeClient` for authentication flows is now deprecated. All new integrations should migrate to the IndexedDB-based authentication provided by `indexedDbClient`. + +### 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/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + +## 4.2.6 + +### Patch Changes + +- fe0957d: Updated the styling of the OtpInput component in the Auth component to remove spinner buttons from numeric inputs. +- Updated dependencies [25ca339] + - @turnkey/sdk-browser@4.3.0 + - @turnkey/sdk-server@3.3.0 + - @turnkey/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + +## 4.2.5 + +### Patch Changes + +- 1cf9243: - Added `openOAuthInPage` to the `authConfig`. This makes the Google, Apple and Facebook login pages replace the current URL, rather than opening in a popup. + - Fixed keyboard input type on mobile. Now, the keyboard will correctly default to "number" input for numeric OTP codes and "text" input for alphanumeric OTP codes. +- Updated dependencies [3f6e415] + - @turnkey/sdk-browser@4.2.0 + - @turnkey/sdk-server@3.2.0 + - @turnkey/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + +## 4.2.4 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/sdk-browser@4.1.0 + - @turnkey/sdk-server@3.1.0 + - @turnkey/crypto@2.3.1 + - @turnkey/wallet-stamper@1.0.3 + +## 4.2.3 + +### Patch Changes + +- 0e630b2: Update supported countries for SMS deliverability in EWK + ## 4.2.2 ### Patch Changes @@ -535,4 +845,4 @@ mode: wide ## 0.0.1 -Initial (experimental) release! This is an alpha release and subject to change. +Initial (experimental) release! This is an alpha release and subject to change. \ No newline at end of file diff --git a/generated-docs/changelogs/sdk-server/readme.mdx b/generated-docs/changelogs/sdk-server/readme.mdx index ec5dc0658..4e6d9fdd8 100644 --- a/generated-docs/changelogs/sdk-server/readme.mdx +++ b/generated-docs/changelogs/sdk-server/readme.mdx @@ -2,9 +2,257 @@ title: "SDK Server" mode: wide --- - + # @turnkey/sdk-server +## 4.7.0-beta.1 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/http@3.10.0-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + - @turnkey/wallet-stamper@1.0.9-beta.4 + +## 4.7.0-beta.0 + +### Minor Changes + +- @turnkey/react-wallet-kit and @turnkey/core beta-3 release + +### Patch Changes + +- Updated dependencies []: + - @turnkey/http@3.10.0-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + - @turnkey/wallet-stamper@1.0.9-beta.3 + +## 4.6.0 + +### Minor Changes + +- [#834](https://github.com/tkhq/sdk/pull/834) [`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9) Author [@moeodeh3](https://github.com/moeodeh3) - Update per mono release v2025.8.3-hotfix.0 + +### Patch Changes + +- [#833](https://github.com/tkhq/sdk/pull/833) [`1a549b7`](https://github.com/tkhq/sdk/commit/1a549b71f9a6e7ab59d52aaae7e58e34c8f2e8b5) Author [@moeodeh3](https://github.com/moeodeh3) - Add optional `includeUnverified` parameter to `getOrCreateSuborg()` to allow inclusion of unverified subOrgs + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9)]: + - @turnkey/http@3.9.0 + - @turnkey/wallet-stamper@1.0.8 + +## 4.5.1-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/wallet-stamper@1.0.9-beta.2 + +## 4.5.1-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/wallet-stamper@1.0.9-beta.0 + +## 4.5.0 + +### Minor Changes + +- [#826](https://github.com/tkhq/sdk/pull/826) [`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0) Author [@turnekybc](https://github.com/turnekybc) - Update per mono release v2025.8.1 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/http@3.8.0 + - @turnkey/wallet-stamper@1.0.8 + +## 4.4.0 + +### Minor Changes + +- [#651](https://github.com/tkhq/sdk/pull/651) [`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed) Author [@turnekybc](https://github.com/turnekybc) - Add Coinbase & MoonPay Fiat Onramp. View the [Fiat Onramp feature docs](https://docs.turnkey.com/wallets/fiat-on-ramp). + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed)]: + - @turnkey/http@3.7.0 + - @turnkey/wallet-stamper@1.0.8 + +## 4.3.0 + +### Minor Changes + +- [#782](https://github.com/tkhq/sdk/pull/782) [`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e) Thanks [@r-n-o](https://github.com/r-n-o)! - Release v2025.7.16 + +### Patch Changes + +- Updated dependencies [[`e90a478`](https://github.com/tkhq/sdk/commit/e90a478c9208d858b1144df9b2c2c7ba956c406e)]: + - @turnkey/http@3.6.0 + - @turnkey/wallet-stamper@1.0.7 + +## 4.2.4 + +### Patch Changes + +- [#780](https://github.com/tkhq/sdk/pull/780) [`2db00b0`](https://github.com/tkhq/sdk/commit/2db00b0a799d09ae33fa08a117e3b2f433f2b0b4) Thanks [@moe-dev](https://github.com/moe-dev)! - Patch fix for server actions leading to unwanted suborg creation when query requests time out + +## 4.2.3 + +### Patch Changes + +- [#763](https://github.com/tkhq/sdk/pull/763) [`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a) Author [@andrewkmin](https://github.com/andrewkmin) - Release per mono v2025.7.1. This release contains the following API changes: + + - Introduction of `SmartContractInterfaces`: we've now exposed endpoints for uploading ABIs and IDLs to help secure EVM and Solana signing flows. For more information, see our docs [here](https://docs.turnkey.com/concepts/policies/smart-contract-interfaces) + +- Updated dependencies [[`cb13c26`](https://github.com/tkhq/sdk/commit/cb13c26edb79a01ab651e3b2897334fd154b436a)]: + - @turnkey/http@3.5.1 + - @turnkey/wallet-stamper@1.0.7 + +## 4.2.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/wallet-stamper@1.0.7 + +## 4.2.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/wallet-stamper@1.0.6 + +## 4.2.0 + +### Minor Changes + +- [#704](https://github.com/tkhq/sdk/pull/704) [`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd) Author [@amircheikh](https://github.com/amircheikh) - Synced with mono 2025.6.10 to include the following endpoints: + + `update_user_email`: Update a User's email in an existing Organization + + `update_user_name`: Update a User's name in an existing Organization + + `update_user_phone_number`: Update a User's phone number in an existing Organization + +### Patch Changes + +- [#698](https://github.com/tkhq/sdk/pull/698) [`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164) Author [@moeodeh3](https://github.com/moeodeh3) - Introduces an optional `runtimeOverride` parameter that allows the ability to explicitly specify the crypto environment: `"browser"`, `"node"`, or `"purejs"`. + +- Updated dependencies [[`5f3dd98`](https://github.com/tkhq/sdk/commit/5f3dd9814650308b3bf3198168c453e7b1a98efd), [`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164)]: + - @turnkey/http@3.5.0 + - @turnkey/api-key-stamper@0.4.7 + - @turnkey/wallet-stamper@1.0.5 + +## 4.1.1 + +### Patch Changes + +- Updated dependencies [[`be0a621`](https://github.com/tkhq/sdk/commit/be0a621fb962bd51d2df1a1e79f5260d7c696772)]: + - @turnkey/http@3.4.2 + - @turnkey/wallet-stamper@1.0.4 + +## 4.1.0 + +### Minor Changes + +- [#632](https://github.com/tkhq/sdk/pull/632) [`a38a6e3`](https://github.com/tkhq/sdk/commit/a38a6e36dc2bf9abdea64bc817d1cad95b8a289a) Author [@amircheikh](https://github.com/amircheikh) - Exposed `createOauthProviders` and `getUsers` as server actions. These are used for social linking within `@turnkey/sdk-react`. + +### Patch Changes + +- [#663](https://github.com/tkhq/sdk/pull/663) [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2) Thanks [@moe-dev](https://github.com/moe-dev)! - Update to endpoints as per mono v2025.5.7. Add V5 TON address format generation. Non breaking + +- Updated dependencies [[`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc), [`593de2d`](https://github.com/tkhq/sdk/commit/593de2d9404ec8cf53426f9cf832c13eefa3fbf2)]: + - @turnkey/wallet-stamper@1.0.4 + - @turnkey/http@3.4.1 + - @turnkey/api-key-stamper@0.4.6 + +## 4.0.1 + +### Patch Changes + +- Update @turnkey/sdk-types readme and install dependency in packages with common types + +- [#650](https://github.com/tkhq/sdk/pull/650) [`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412) Author [@turnekybc](https://github.com/turnekybc) - Update @turnkey/sdk-types readme and install dependency in packages with common types + +## 4.0.0 + +### Major Changes + +- [#601](https://github.com/tkhq/sdk/pull/601) [`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0) Author [@moe-dev](https://github.com/moe-dev). + +This release introduces significant updates and new actions to the SDK server methods, enhancing authentication flows and simplifying usage: + +**Updated Actions:** + +- `sendOtp`: No longer requires a suborganization ID; OTPs can now be sent directly under a parent organization's context to any email or phone number. + +- `verifyOtp`: Now returns a `verificationToken`, which is required for creating sessions via the new `otpLogin` action. + +**New Actions:** + +- `otpLogin`: Creates a session using a previously obtained `verificationToken`. Returns a session JWT. + +- `oauthLogin`: Authenticates using an OIDC token obtained from a third-party provider (e.g., Google, Apple, Facebook). Returns a session JWT. + +These changes standardize authentication processes, simplify integration, and streamline session management across the SDK. + +### Patch Changes + +- [#631](https://github.com/tkhq/sdk/pull/631) [`e8a5f1b`](https://github.com/tkhq/sdk/commit/e8a5f1b431623c4ff1cb85c6039464b328cf0e6a) Author [@andrewkmin](https://github.com/andrewkmin) - Remove unused Next.js dependency + + - while the `"use server"` directive in `actions.ts` is to be used specifically with Next, removing it from this package (`@turnkey/sdk-server`) is fine, though applications _using_ this package will need Next.js + +- Updated dependencies [[`07dfd33`](https://github.com/tkhq/sdk/commit/07dfd3397472687092e1c73b1d68714f421b9ca0)]: + - @turnkey/http@3.4.0 + - @turnkey/wallet-stamper@1.0.3 + +## 3.3.0 + +### Minor Changes + +- 25ca339: Adding replyToEmailAddress field for specifying reply-to when using a customer sender + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/http@3.3.0 + - @turnkey/wallet-stamper@1.0.3 + +## 3.2.0 + +### Minor Changes + +- 3f6e415: Update per mono v2025.4.5 + +### Patch Changes + +- Updated dependencies [3f6e415] +- Updated dependencies [4d1d775] + - @turnkey/http@3.2.0 + - @turnkey/api-key-stamper@0.4.5 + - @turnkey/wallet-stamper@1.0.3 + +## 3.1.0 + +### Minor Changes + +- 3e4a482: Release per mono v2025.4.4 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/http@3.1.0 + - @turnkey/wallet-stamper@1.0.3 + ## 3.0.1 ### Patch Changes @@ -385,4 +633,4 @@ mode: wide ## 0.0.1 -Initial (experimental) release! This is an alpha release and subject to change. +Initial (experimental) release! This is an alpha release and subject to change. \ No newline at end of file diff --git a/generated-docs/changelogs/solana/readme.mdx b/generated-docs/changelogs/solana/readme.mdx index a344d9a98..03d539022 100644 --- a/generated-docs/changelogs/solana/readme.mdx +++ b/generated-docs/changelogs/solana/readme.mdx @@ -2,9 +2,223 @@ title: "Solana" mode: wide --- - + # @turnkey/solana +## 1.0.41-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.1 + - @turnkey/http@3.10.0-beta.1 + - @turnkey/sdk-browser@5.7.1-beta.1 + +## 1.0.41-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.0 + - @turnkey/http@3.10.0-beta.0 + - @turnkey/sdk-browser@5.7.1-beta.0 + +## 1.0.41-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/sdk-server@4.5.1-beta.2 + +## 1.0.41-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.1 + - @turnkey/http@3.8.1-beta.1 + - @turnkey/sdk-server@4.5.1-beta.1 + +## 1.0.41-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/sdk-server@4.5.1-beta.0 + +## 1.0.41 + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9), [`1a549b7`](https://github.com/tkhq/sdk/commit/1a549b71f9a6e7ab59d52aaae7e58e34c8f2e8b5)]: + - @turnkey/sdk-browser@5.7.0 + - @turnkey/sdk-server@4.6.0 + - @turnkey/http@3.9.0 + +## 1.0.40 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/sdk-browser@5.6.0 + - @turnkey/sdk-server@4.5.0 + - @turnkey/http@3.8.0 + +## 1.0.39 + +### Patch Changes + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed)]: + - @turnkey/http@3.7.0 + - @turnkey/sdk-browser@5.5.0 + - @turnkey/sdk-server@4.4.0 + +## 1.0.38 + +### Patch Changes + +- Updated dependencies [[`0d1eb2c`](https://github.com/tkhq/sdk/commit/0d1eb2c464bac3cf6f4386f402604ecf8f373f15)]: + - @turnkey/sdk-browser@5.4.1 + +## 1.0.37 + +### 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 + +## 1.0.36 + +### Patch Changes + +- Updated dependencies [[`2db00b0`](https://github.com/tkhq/sdk/commit/2db00b0a799d09ae33fa08a117e3b2f433f2b0b4)]: + - @turnkey/sdk-server@4.2.4 + +## 1.0.35 + +### 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 + +## 1.0.34 + +### Patch Changes + +- Updated dependencies [[`2c4f42c`](https://github.com/tkhq/sdk/commit/2c4f42c747ac8017cf17e86b0ca0c3fa6f593bbf)]: + - @turnkey/sdk-browser@5.3.3 + +## 1.0.33 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.3.2 + - @turnkey/sdk-server@4.2.2 + +## 1.0.32 + +### Patch Changes + +- Updated dependencies [[`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]: + - @turnkey/sdk-browser@5.3.1 + - @turnkey/sdk-server@4.2.1 + +## 1.0.31 + +### 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 + +## 1.0.30 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.3 + +## 1.0.29 + +### Patch Changes + +- Updated dependencies: + - @turnkey/sdk-browser@5.2.2 + +## 1.0.28 + +### 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 + +## 1.0.27 + +### 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 + +## 1.0.26 + +### Patch Changes + +- Updated dependencies [[`27fe590`](https://github.com/tkhq/sdk/commit/27fe590cdc3eb6a8cde093eeefda2ee1cdc79412)]: + - @turnkey/sdk-browser@5.1.0 + - @turnkey/sdk-server@4.0.1 + +## 1.0.25 + +### 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 + +## 1.0.24 + +### Patch Changes + +- Updated dependencies [25ca339] + - @turnkey/sdk-browser@4.3.0 + - @turnkey/sdk-server@3.3.0 + - @turnkey/http@3.3.0 + +## 1.0.23 + +### Patch Changes + +- Updated dependencies [3f6e415] + - @turnkey/sdk-browser@4.2.0 + - @turnkey/sdk-server@3.2.0 + - @turnkey/http@3.2.0 + +## 1.0.22 + +### Patch Changes + +- Updated dependencies [3e4a482] + - @turnkey/sdk-browser@4.1.0 + - @turnkey/sdk-server@3.1.0 + - @turnkey/http@3.1.0 + ## 1.0.21 ### Patch Changes @@ -379,4 +593,4 @@ Add support for signing Solana versioned transactions (#216) ## 0.1.0 -- Initial release +- Initial release \ No newline at end of file diff --git a/generated-docs/changelogs/telegram-cloud-storage-stamper/readme.mdx b/generated-docs/changelogs/telegram-cloud-storage-stamper/readme.mdx index 110d6acfa..d5119ab71 100644 --- a/generated-docs/changelogs/telegram-cloud-storage-stamper/readme.mdx +++ b/generated-docs/changelogs/telegram-cloud-storage-stamper/readme.mdx @@ -2,9 +2,65 @@ title: "Telegram Cloud Storage Stamper" mode: wide --- - + # @turnkey/telegram-cloud-storage-stamper +## 2.0.4-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.8-beta.4 + +## 2.0.4-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.8-beta.3 + +## 2.0.4-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.8-beta.2 + +## 2.0.4-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.8-beta.1 + +## 2.0.4-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.8-beta.0 + +## 2.0.3 + +### Patch Changes + +- Updated dependencies [[`7625df0`](https://github.com/tkhq/sdk/commit/7625df0538002c3455bd5862211210e38472e164)]: + - @turnkey/api-key-stamper@0.4.7 + +## 2.0.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/api-key-stamper@0.4.6 + +## 2.0.1 + +### Patch Changes + +- Updated dependencies [4d1d775] + - @turnkey/api-key-stamper@0.4.5 + ## 2.0.0 ### Major Changes @@ -53,4 +109,4 @@ mode: wide ### Major Changes -- Initial release of the telegram-cloud-storage-stamper package. This package is to be used alongside Telegram mini-app development and provides a stamping utility and an interface into Telegram Cloud Storage. More can be read in the [readme](../packages/telegram-cloud-storage-stamper/readme.md). +- Initial release of the telegram-cloud-storage-stamper package. This package is to be used alongside Telegram mini-app development and provides a stamping utility and an interface into Telegram Cloud Storage. More can be read in the [readme](../packages/telegram-cloud-storage-stamper/readme.md). \ No newline at end of file diff --git a/generated-docs/changelogs/viem/readme.mdx b/generated-docs/changelogs/viem/readme.mdx index 6250142ca..d9b48cc4f 100644 --- a/generated-docs/changelogs/viem/readme.mdx +++ b/generated-docs/changelogs/viem/readme.mdx @@ -2,9 +2,275 @@ title: "Viem" mode: wide --- - + # @turnkey/viem +## 0.12.1-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.1 + - @turnkey/http@3.10.0-beta.1 + - @turnkey/sdk-browser@5.7.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.4 + +## 0.12.1-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-server@4.7.0-beta.0 + - @turnkey/http@3.10.0-beta.0 + - @turnkey/sdk-browser@5.7.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.3 + +## 0.12.0 + +### Minor Changes + +- [#642](https://github.com/tkhq/sdk/pull/642) [`7898dce`](https://github.com/tkhq/sdk/commit/7898dce1b71c1f956a588636a29c56e47b013426) Author [@andrewkmin](https://github.com/andrewkmin) - - Add implementation for `sign`. This is primarily applicable for account abstraction use cases. + - Enforce message hashing at an abstracted level. + - Minor bugfixes: pass through payload encoding; enforce default value for `to` parameter (abstracted away from user -- non-breaking) + +### Patch Changes + +- Updated dependencies [[`8b39dba`](https://github.com/tkhq/sdk/commit/8b39dbabf68d3e376b5b07f26960d5b61ae87fa9), [`1a549b7`](https://github.com/tkhq/sdk/commit/1a549b71f9a6e7ab59d52aaae7e58e34c8f2e8b5)]: + - @turnkey/sdk-browser@5.7.0 + - @turnkey/sdk-server@4.6.0 + - @turnkey/http@3.9.0 + +## 0.11.2-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.2 + - @turnkey/api-key-stamper@0.4.8-beta.2 + - @turnkey/http@3.8.1-beta.2 + - @turnkey/sdk-server@4.5.1-beta.2 + +## 0.11.2-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.1 + - @turnkey/api-key-stamper@0.4.8-beta.1 + - @turnkey/http@3.8.1-beta.1 + - @turnkey/sdk-server@4.5.1-beta.1 + +## 0.11.2-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/sdk-browser@5.6.1-beta.0 + - @turnkey/api-key-stamper@0.4.8-beta.0 + - @turnkey/http@3.8.1-beta.0 + - @turnkey/sdk-server@4.5.1-beta.0 + +## 0.11.1 + +### Patch Changes + +- Updated dependencies [[`f83f25b`](https://github.com/tkhq/sdk/commit/f83f25ba33ef15dbd66723531eebe2fd00f43ac0)]: + - @turnkey/sdk-browser@5.6.0 + - @turnkey/sdk-server@4.5.0 + - @turnkey/http@3.8.0 + +## 0.11.0 + +### Minor Changes + +- [#651](https://github.com/tkhq/sdk/pull/651) [`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed) Author [@turnekybc](https://github.com/turnekybc) - Add Coinbase & MoonPay Fiat Onramp. View the [Fiat Onramp feature docs](https://docs.turnkey.com/wallets/fiat-on-ramp). + +### Patch Changes + +- [#808](https://github.com/tkhq/sdk/pull/808) [`517d1d8`](https://github.com/tkhq/sdk/commit/517d1d83f7d4f9e000c7b47ff93e7a23daf4f6d2) Author [@moeodeh3](https://github.com/moeodeh3) - Fix serialization with BigInt values in `signTypedData()` + +- Updated dependencies [[`81e355c`](https://github.com/tkhq/sdk/commit/81e355c9a8321feffcac056916b65139cf35eeed)]: + - @turnkey/http@3.7.0 + - @turnkey/sdk-browser@5.5.0 + - @turnkey/sdk-server@4.4.0 + +## 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 @@ -624,4 +890,4 @@ const turnkeyAccount = await createAccount({ ## 0.1.0 -Initial release! +Initial release! \ No newline at end of file diff --git a/generated-docs/changelogs/wallet-stamper/readme.mdx b/generated-docs/changelogs/wallet-stamper/readme.mdx index 62bf614d0..fc5ce388d 100644 --- a/generated-docs/changelogs/wallet-stamper/readme.mdx +++ b/generated-docs/changelogs/wallet-stamper/readme.mdx @@ -2,9 +2,87 @@ title: "Wallet Stamper" mode: wide --- - + # @turnkey/wallet-stamper +## 1.0.9-beta.4 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.4 + - @turnkey/crypto@2.5.1-beta.4 + +## 1.0.9-beta.3 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.3 + - @turnkey/crypto@2.5.1-beta.3 + +## 1.0.9-beta.2 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.2 + - @turnkey/crypto@2.5.1-beta.2 + +## 1.0.9-beta.1 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.1 + - @turnkey/crypto@2.5.1-beta.1 + +## 1.0.9-beta.0 + +### Patch Changes + +- Updated dependencies []: + - @turnkey/encoding@0.6.0-beta.0 + - @turnkey/crypto@2.5.1-beta.0 + +## 1.0.8 + +### Patch Changes + +- Updated dependencies [[`6cde41c`](https://github.com/tkhq/sdk/commit/6cde41cfecdfb7d54abf52cc65e28ef0e2ad6ba3)]: + - @turnkey/crypto@2.5.0 + +## 1.0.7 + +### Patch Changes + +- Updated dependencies [[`6cbff7a`](https://github.com/tkhq/sdk/commit/6cbff7a0c0b3a9a05586399e5cef476154d3bdca)]: + - @turnkey/crypto@2.4.3 + +## 1.0.6 + +### Patch Changes + +- Updated dependencies [[`c5cdf82`](https://github.com/tkhq/sdk/commit/c5cdf8229da5da1bd6d52db06b2fe42826e96d57), [`fa46701`](https://github.com/tkhq/sdk/commit/fa467019eef34b5199372248edff1e7a64934e79)]: + - @turnkey/crypto@2.4.2 + +## 1.0.5 + +### Patch Changes + +- Updated dependencies [[`878e039`](https://github.com/tkhq/sdk/commit/878e03973856cfec83e6e3fda5b76d1b64943628)]: + - @turnkey/crypto@2.4.1 + +## 1.0.4 + +### Patch Changes + +- [#659](https://github.com/tkhq/sdk/pull/659) [`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc) Author [@turnekybc](https://github.com/turnekybc) - export types and models from @turnkey/sdk-browser + +- Updated dependencies [[`40c4035`](https://github.com/tkhq/sdk/commit/40c40359ec7096d0bca39ffc93e89361b3b11a1a), [`10ee5c5`](https://github.com/tkhq/sdk/commit/10ee5c524b477ce998e4fc635152cd101ae5a9cc)]: + - @turnkey/encoding@0.5.0 + - @turnkey/crypto@2.4.0 + ## 1.0.3 ### Patch Changes @@ -89,4 +167,4 @@ mode: wide ### Patch Changes -- 68a14dd: Initial release! 🎉 +- 68a14dd: Initial release! 🎉 \ No newline at end of file diff --git a/generated-docs/changelogs/webauthn-stamper/readme.mdx b/generated-docs/changelogs/webauthn-stamper/readme.mdx index 1ea5b3469..543aaa5a9 100644 --- a/generated-docs/changelogs/webauthn-stamper/readme.mdx +++ b/generated-docs/changelogs/webauthn-stamper/readme.mdx @@ -2,9 +2,15 @@ title: "Webauthn Stamper" mode: wide --- - + # @turnkey/webauthn-stamper +## 0.5.1 + +### Patch Changes + +- [#659](https://github.com/tkhq/sdk/pull/659) [`5afbe51`](https://github.com/tkhq/sdk/commit/5afbe51949bdd1997fad083a4c1e4272ff7409dc) Author [@turnekybc](https://github.com/turnekybc) - export types and models from @turnkey/sdk-browser + ## 0.5.0 ### Minor Changes @@ -50,4 +56,4 @@ mode: wide ## 0.1.0 -Initial release +Initial release \ No newline at end of file diff --git a/generated-docs/docs.json b/generated-docs/docs.json index c3d284c08..784fca6f3 100644 --- a/generated-docs/docs.json +++ b/generated-docs/docs.json @@ -1,2100 +1,341 @@ { + "$schema": "https://mintlify.com/docs.json", + "theme": "mint", + "name": "Turnkey", + "colors": { + "primary": "#6a5bf5", + "light": "#6a5bf5", + "dark": "#050a0b" + }, + "contextual": { + "options": ["copy", "view", "chatgpt", "claude"] + }, + "favicon": "/favicon.svg", "navigation": { "tabs": [ { - "tab": "SDK Reference", + "tab": "Documentation", "groups": [ { - "group": "SDK Reference", + "group": "Get Started", "pages": [ + "home", { - "group": "sdks", + "group": "Concepts", "pages": [ + "concepts/overview", + "concepts/organizations", + "concepts/sub-organizations", + "concepts/users/introduction", + "concepts/wallets", + "concepts/resource-limits", + "concepts/policies/overview" + ] + }, + { + "group": "Architecture", + "pages": [ + "products/transaction-automation/features/security/quorum-os", + "products/transaction-automation/features/security/remote-attestation", + "products/transaction-automation/features/security/secure-hardware", + "sdks/cli" + ] + }, + "getting-started/quickstart", + { + "group": "Quickstarts", + "pages": [ + "getting-started/embedded-wallet-quickstart", + "getting-started/signing-automation-quickstart" + ] + }, + { + "group": "Production Checklist", + "pages": [ + "production-checklist/production-checklist", + "production-checklist/embedded-wallet", + "production-checklist/transaction-automation" + ] + } + ] + }, + { + "group": "Products", + "pages": [ + { + "group": "Embedded Wallets", + "pages": [ + "embedded-wallets/overview", { - "group": "_media", - "pages": [] - }, - { - "group": "api-key-stamper", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": ["sdks/api-key-stamper/ApiKeyStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": [ - "sdks/api-key-stamper/index/ApiKeyStamper/readme" - ] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/api-key-stamper/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "pointDecode", - "pages": [ - "sdks/api-key-stamper/index/pointDecode/readme" - ] - }, - "sdks/api-key-stamper/index/readme", - { - "group": "signWithApiKey", - "pages": [ - "sdks/api-key-stamper/index/signWithApiKey/readme" - ] - } - ] - }, - "sdks/api-key-stamper/readme" - ] - }, - { - "group": "cosmjs", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/cosmjs/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/cosmjs/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyDirectWallet", - "pages": [ - "sdks/cosmjs/index/TurnkeyDirectWallet/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/cosmjs/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "fetchCompressedPublicKey", - "pages": [ - "sdks/cosmjs/index/fetchCompressedPublicKey/readme" - ] - }, - "sdks/cosmjs/index/readme" - ] - }, - "sdks/cosmjs/readme" - ] - }, - { - "group": "crypto", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "buildAdditionalAssociatedData", - "pages": [ - "sdks/crypto/index/buildAdditionalAssociatedData/readme" - ] - }, - { - "group": "compressRawPublicKey", - "pages": [ - "sdks/crypto/index/compressRawPublicKey/readme" - ] - }, - { - "group": "decryptCredentialBundle", - "pages": [ - "sdks/crypto/index/decryptCredentialBundle/readme" - ] - }, - { - "group": "decryptExportBundle", - "pages": [ - "sdks/crypto/index/decryptExportBundle/readme" - ] - }, - { - "group": "encryptPrivateKeyToBundle", - "pages": [ - "sdks/crypto/index/encryptPrivateKeyToBundle/readme" - ] - }, - { - "group": "encryptWalletToBundle", - "pages": [ - "sdks/crypto/index/encryptWalletToBundle/readme" - ] - }, - { - "group": "extractPrivateKeyFromPKCS8Bytes", - "pages": [ - "sdks/crypto/index/extractPrivateKeyFromPKCS8Bytes/readme" - ] - }, - { - "group": "formatHpkeBuf", - "pages": ["sdks/crypto/index/formatHpkeBuf/readme"] - }, - { - "group": "fromDerSignature", - "pages": [ - "sdks/crypto/index/fromDerSignature/readme" - ] - }, - { - "group": "generateP256KeyPair", - "pages": [ - "sdks/crypto/index/generateP256KeyPair/readme" - ] - }, - { - "group": "getPublicKey", - "pages": ["sdks/crypto/index/getPublicKey/readme"] - }, - { - "group": "hpkeAuthEncrypt", - "pages": [ - "sdks/crypto/index/hpkeAuthEncrypt/readme" - ] - }, - { - "group": "hpkeDecrypt", - "pages": ["sdks/crypto/index/hpkeDecrypt/readme"] - }, - { - "group": "hpkeEncrypt", - "pages": ["sdks/crypto/index/hpkeEncrypt/readme"] - }, - "sdks/crypto/index/readme", - { - "group": "toDerSignature", - "pages": ["sdks/crypto/index/toDerSignature/readme"] - }, - { - "group": "uncompressRawPublicKey", - "pages": [ - "sdks/crypto/index/uncompressRawPublicKey/readme" - ] - }, - { - "group": "verifyStampSignature", - "pages": [ - "sdks/crypto/index/verifyStampSignature/readme" - ] - } - ] - }, - "sdks/crypto/readme" - ] - }, - { - "group": "eip-1193-provider", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": [ - "sdks/eip-1193-provider/documents/docs/readme" - ] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyEIP1193Provider", - "pages": [ - "sdks/eip-1193-provider/index/TurnkeyEIP1193Provider/readme" - ] - }, - { - "group": "createEIP1193Provider", - "pages": [ - "sdks/eip-1193-provider/index/createEIP1193Provider/readme" - ] - }, - "sdks/eip-1193-provider/index/readme" - ] - }, - "sdks/eip-1193-provider/readme" - ] - }, - { - "group": "encoding", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "DEFAULT_JWK_MEMBER_BYTE_LENGTH", - "pages": [ - "sdks/encoding/index/DEFAULT_JWK_MEMBER_BYTE_LENGTH/readme" - ] - }, - { - "group": "base64StringToBase64UrlEncodedString", - "pages": [ - "sdks/encoding/index/base64StringToBase64UrlEncodedString/readme" - ] - }, - { - "group": "hexStringToBase64url", - "pages": [ - "sdks/encoding/index/hexStringToBase64url/readme" - ] - }, - { - "group": "hexToAscii", - "pages": ["sdks/encoding/index/hexToAscii/readme"] - }, - { - "group": "normalizePadding", - "pages": [ - "sdks/encoding/index/normalizePadding/readme" - ] - }, - "sdks/encoding/index/readme", - { - "group": "stringToBase64urlString", - "pages": [ - "sdks/encoding/index/stringToBase64urlString/readme" - ] - }, - { - "group": "uint8ArrayFromHexString", - "pages": [ - "sdks/encoding/index/uint8ArrayFromHexString/readme" - ] - }, - { - "group": "uint8ArrayToHexString", - "pages": [ - "sdks/encoding/index/uint8ArrayToHexString/readme" - ] - } - ] - }, - "sdks/encoding/readme" - ] - }, - { - "group": "ethers", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/ethers/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/ethers/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/ethers/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeySigner", - "pages": ["sdks/ethers/index/TurnkeySigner/readme"] - }, - "sdks/ethers/index/readme", - { - "group": "serializeSignature", - "pages": [ - "sdks/ethers/index/serializeSignature/readme" - ] - } - ] - }, - "sdks/ethers/readme" - ] - }, - { - "group": "http", - "pages": [ - { - "group": "TurnkeyClient", - "pages": ["sdks/http/TurnkeyClient/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "InvalidArgumentError", - "pages": [ - "sdks/http/index/InvalidArgumentError/readme" - ] - }, - { - "group": "SignedRequest", - "pages": ["sdks/http/index/SignedRequest/readme"] - }, - { - "group": "TActivity", - "pages": ["sdks/http/index/TActivity/readme"] - }, - { - "group": "TActivityId", - "pages": ["sdks/http/index/TActivityId/readme"] - }, - { - "group": "TActivityResponse", - "pages": [ - "sdks/http/index/TActivityResponse/readme" - ] - }, - { - "group": "TActivityStatus", - "pages": ["sdks/http/index/TActivityStatus/readme"] - }, - { - "group": "TActivityType", - "pages": ["sdks/http/index/TActivityType/readme"] - }, - { - "group": "TERMINAL_ACTIVITY_STATUSES", - "pages": [ - "sdks/http/index/TERMINAL_ACTIVITY_STATUSES/readme" - ] - }, - { - "group": "TSignature", - "pages": ["sdks/http/index/TSignature/readme"] - }, - { - "group": "TSignedRequest", - "pages": ["sdks/http/index/TSignedRequest/readme"] - }, - { - "group": "TurnkeyActivityConsensusNeededError", - "pages": [ - "sdks/http/index/TurnkeyActivityConsensusNeededError/readme" - ] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/http/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/http/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "VERSION", - "pages": ["sdks/http/index/VERSION/readme"] - }, - { - "group": "assertActivityCompleted", - "pages": [ - "sdks/http/index/assertActivityCompleted/readme" - ] - }, - { - "group": "assertNonNull", - "pages": ["sdks/http/index/assertNonNull/readme"] - }, - { - "group": "browserInit", - "pages": ["sdks/http/index/browserInit/readme"] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/http/index/createActivityPoller/readme" - ] - }, - { - "group": "getSignatureFromActivity", - "pages": [ - "sdks/http/index/getSignatureFromActivity/readme" - ] - }, - { - "group": "getSignaturesFromActivity", - "pages": [ - "sdks/http/index/getSignaturesFromActivity/readme" - ] - }, - { - "group": "getSignedTransactionFromActivity", - "pages": [ - "sdks/http/index/getSignedTransactionFromActivity/readme" - ] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/http/index/getWebAuthnAttestation/readme" - ] - }, - { - "group": "init", - "pages": ["sdks/http/index/init/readme"] - }, - "sdks/http/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/http/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "withAsyncPolling", - "pages": ["sdks/http/index/withAsyncPolling/readme"] - } - ] - }, - "sdks/http/readme" - ] - }, - { - "group": "iframe-stamper", - "pages": [ - { - "group": "IframeStamper", - "pages": ["sdks/iframe-stamper/IframeStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "IframeEventType", - "pages": [ - "sdks/iframe-stamper/index/IframeEventType/readme" - ] - }, - { - "group": "IframeStamper", - "pages": [ - "sdks/iframe-stamper/index/IframeStamper/readme" - ] - }, - { - "group": "KeyFormat", - "pages": [ - "sdks/iframe-stamper/index/KeyFormat/readme" - ] - }, - { - "group": "TIframeSettings", - "pages": [ - "sdks/iframe-stamper/index/TIframeSettings/readme" - ] - }, - { - "group": "TIframeStamperConfig", - "pages": [ - "sdks/iframe-stamper/index/TIframeStamperConfig/readme" - ] - }, - { - "group": "TIframeStyles", - "pages": [ - "sdks/iframe-stamper/index/TIframeStyles/readme" - ] - }, - "sdks/iframe-stamper/index/readme" - ] - }, - "sdks/iframe-stamper/readme" - ] - }, - "sdks/modules", - { - "group": "react-native-passkey-stamper", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "AuthenticatorTransport", - "pages": [ - "sdks/react-native-passkey-stamper/index/AuthenticatorTransport/readme" - ] - }, - { - "group": "PasskeyStamper", - "pages": [ - "sdks/react-native-passkey-stamper/index/PasskeyStamper/readme" - ] - }, - { - "group": "PublicKeyCredentialDescriptor", - "pages": [ - "sdks/react-native-passkey-stamper/index/PublicKeyCredentialDescriptor/readme" - ] - }, - { - "group": "TPasskeyRegistrationConfig", - "pages": [ - "sdks/react-native-passkey-stamper/index/TPasskeyRegistrationConfig/readme" - ] - }, - { - "group": "TPasskeyStamperConfig", - "pages": [ - "sdks/react-native-passkey-stamper/index/TPasskeyStamperConfig/readme" - ] - }, - { - "group": "TurnkeyAuthenticatorParams", - "pages": [ - "sdks/react-native-passkey-stamper/index/TurnkeyAuthenticatorParams/readme" - ] - }, - { - "group": "createPasskey", - "pages": [ - "sdks/react-native-passkey-stamper/index/createPasskey/readme" - ] - }, - { - "group": "isSupported", - "pages": [ - "sdks/react-native-passkey-stamper/index/isSupported/readme" - ] - }, - "sdks/react-native-passkey-stamper/index/readme" - ] - }, - "sdks/react-native-passkey-stamper/readme" - ] - }, - "sdks/readme", - { - "group": "sdk-browser", - "pages": [ - { - "group": "JavaScript_Browser", - "pages": ["sdks/sdk-browser/JavaScript_Browser/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": [ - "sdks/sdk-browser/index/ApiKeyStamper/readme" - ] - }, - { - "group": "DEFAULT_APTOS_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_APTOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_COSMOS_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_COSMOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_MAINNET_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_DOGE_MAINNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_TESTNET_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_DOGE_TESTNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_ETHEREUM_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_ETHEREUM_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SEI_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SEI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SOLANA_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SOLANA_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SUI_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SUI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V3R2_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TON_V3R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V4R2_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TON_V4R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TRON_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TRON_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_XLM_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_XLM_ACCOUNTS/readme" - ] - }, - { - "group": "IframeEventType", - "pages": [ - "sdks/sdk-browser/index/IframeEventType/readme" - ] - }, - { - "group": "IframeStamper", - "pages": [ - "sdks/sdk-browser/index/IframeStamper/readme" - ] - }, - { - "group": "StorageKeys", - "pages": [ - "sdks/sdk-browser/index/StorageKeys/readme" - ] - }, - { - "group": "TActivity", - "pages": ["sdks/sdk-browser/index/TActivity/readme"] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "TIframeStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TIframeStamperConfig/readme" - ] - }, - { - "group": "TSignedRequest", - "pages": [ - "sdks/sdk-browser/index/TSignedRequest/readme" - ] - }, - { - "group": "TWebauthnStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TWebauthnStamperConfig/readme" - ] - }, - { - "group": "Turnkey", - "pages": ["sdks/sdk-browser/index/Turnkey/readme"] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/sdk-browser/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyBrowserClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyBrowserClient/readme" - ] - }, - { - "group": "TurnkeyIframeClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyIframeClient/readme" - ] - }, - { - "group": "TurnkeyPasskeyClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyPasskeyClient/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/sdk-browser/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeyWalletClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyWalletClient/readme" - ] - }, - { - "group": "WalletAccount", - "pages": [ - "sdks/sdk-browser/index/WalletAccount/readme" - ] - }, - { - "group": "WebauthnStamper", - "pages": [ - "sdks/sdk-browser/index/WebauthnStamper/readme" - ] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/sdk-browser/index/createActivityPoller/readme" - ] - }, - { - "group": "defaultAptosAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultAptosAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultCosmosAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultCosmosAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeMainnetAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultDogeMainnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeTestnetAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultDogeTestnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultEthereumAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultEthereumAccountAtIndex/readme" - ] - }, - { - "group": "defaultSeiAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSeiAccountAtIndex/readme" - ] - }, - { - "group": "defaultSolanaAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSolanaAccountAtIndex/readme" - ] - }, - { - "group": "defaultSuiAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSuiAccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV3r2AccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTonV3r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV4r2AccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTonV4r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTronAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTronAccountAtIndex/readme" - ] - }, - { - "group": "defaultXlmAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultXlmAccountAtIndex/readme" - ] - }, - { - "group": "defaultXrpAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultXrpAccountAtIndex/readme" - ] - }, - { - "group": "getStorageValue", - "pages": [ - "sdks/sdk-browser/index/getStorageValue/readme" - ] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/sdk-browser/index/getWebAuthnAttestation/readme" - ] - }, - "sdks/sdk-browser/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/sdk-browser/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "setStorageValue", - "pages": [ - "sdks/sdk-browser/index/setStorageValue/readme" - ] - }, - { - "group": "signWithApiKey", - "pages": [ - "sdks/sdk-browser/index/signWithApiKey/readme" - ] - } - ] - }, - "sdks/sdk-browser/readme" - ] - }, - { - "group": "sdk-react", - "pages": [ - { - "group": "React", - "pages": ["sdks/sdk-react/React/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "Auth", - "pages": ["sdks/sdk-react/index/Auth/readme"] - }, - { - "group": "Export", - "pages": ["sdks/sdk-react/index/Export/readme"] - }, - { - "group": "FilterType", - "pages": ["sdks/sdk-react/index/FilterType/readme"] - }, - { - "group": "Import", - "pages": ["sdks/sdk-react/index/Import/readme"] - }, - { - "group": "OtpType", - "pages": ["sdks/sdk-react/index/OtpType/readme"] - }, - { - "group": "OtpVerification", - "pages": [ - "sdks/sdk-react/index/OtpVerification/readme" - ] - }, - { - "group": "TurnkeyContext", - "pages": [ - "sdks/sdk-react/index/TurnkeyContext/readme" - ] - }, - { - "group": "TurnkeyProvider", - "pages": [ - "sdks/sdk-react/index/TurnkeyProvider/readme" - ] - }, - { - "group": "TurnkeyThemeProvider", - "pages": [ - "sdks/sdk-react/index/TurnkeyThemeProvider/readme" - ] - }, - "sdks/sdk-react/index/readme", - { - "group": "useTurnkey", - "pages": ["sdks/sdk-react/index/useTurnkey/readme"] - } - ] - }, - "sdks/sdk-react/readme" - ] - }, - { - "group": "sdk-react-native", - "pages": [ - { - "group": "React_Native", - "pages": ["sdks/sdk-react-native/React_Native/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "AddressFormat", - "pages": [ - "sdks/sdk-react-native/index/AddressFormat/readme" - ] - }, - { - "group": "Curve", - "pages": [ - "sdks/sdk-react-native/index/Curve/readme" - ] - }, - { - "group": "OTP_AUTH_DEFAULT_EXPIRATION_SECONDS", - "pages": [ - "sdks/sdk-react-native/index/OTP_AUTH_DEFAULT_EXPIRATION_SECONDS/readme" - ] - }, - { - "group": "PathFormat", - "pages": [ - "sdks/sdk-react-native/index/PathFormat/readme" - ] - }, - { - "group": "Session", - "pages": [ - "sdks/sdk-react-native/index/Session/readme" - ] - }, - { - "group": "StorageKeys", - "pages": [ - "sdks/sdk-react-native/index/StorageKeys/readme" - ] - }, - { - "group": "Timestamp", - "pages": [ - "sdks/sdk-react-native/index/Timestamp/readme" - ] - }, - { - "group": "TurnkeyConfig", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyConfig/readme" - ] - }, - { - "group": "TurnkeyContext", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyContext/readme" - ] - }, - { - "group": "TurnkeyProvider", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyProvider/readme" - ] - }, - { - "group": "User", - "pages": ["sdks/sdk-react-native/index/User/readme"] - }, - { - "group": "Wallet", - "pages": [ - "sdks/sdk-react-native/index/Wallet/readme" - ] - }, - { - "group": "WalletAccount", - "pages": [ - "sdks/sdk-react-native/index/WalletAccount/readme" - ] - }, - "sdks/sdk-react-native/index/readme", - { - "group": "useTurnkey", - "pages": [ - "sdks/sdk-react-native/index/useTurnkey/readme" - ] - } - ] - }, - "sdks/sdk-react-native/readme" - ] - }, - { - "group": "sdk-server", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/sdk-server/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": [ - "sdks/sdk-server/index/ApiKeyStamper/readme" - ] - }, - { - "group": "DEFAULT_APTOS_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_APTOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_COSMOS_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_COSMOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_MAINNET_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_DOGE_MAINNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_TESTNET_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_DOGE_TESTNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_ETHEREUM_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_ETHEREUM_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SEI_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SEI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SOLANA_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SOLANA_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SUI_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SUI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V3R2_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TON_V3R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V4R2_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TON_V4R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TRON_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TRON_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_XLM_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_XLM_ACCOUNTS/readme" - ] - }, - { - "group": "TActivity", - "pages": ["sdks/sdk-server/index/TActivity/readme"] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/sdk-server/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "TSignedRequest", - "pages": [ - "sdks/sdk-server/index/TSignedRequest/readme" - ] - }, - { - "group": "Turnkey", - "pages": ["sdks/sdk-server/index/Turnkey/readme"] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/sdk-server/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyApiClient", - "pages": [ - "sdks/sdk-server/index/TurnkeyApiClient/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/sdk-server/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeyServerClient", - "pages": [ - "sdks/sdk-server/index/TurnkeyServerClient/readme" - ] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/sdk-server/index/createActivityPoller/readme" - ] - }, - { - "group": "defaultAptosAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultAptosAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultCosmosAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultCosmosAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeMainnetAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultDogeMainnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeTestnetAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultDogeTestnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultEthereumAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultEthereumAccountAtIndex/readme" - ] - }, - { - "group": "defaultSeiAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSeiAccountAtIndex/readme" - ] - }, - { - "group": "defaultSolanaAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSolanaAccountAtIndex/readme" - ] - }, - { - "group": "defaultSuiAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSuiAccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV3r2AccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTonV3r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV4r2AccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTonV4r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTronAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTronAccountAtIndex/readme" - ] - }, - { - "group": "defaultXlmAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultXlmAccountAtIndex/readme" - ] - }, - { - "group": "defaultXrpAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultXrpAccountAtIndex/readme" - ] - }, - { - "group": "fetch", - "pages": ["sdks/sdk-server/index/fetch/readme"] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/sdk-server/index/getWebAuthnAttestation/readme" - ] - }, - "sdks/sdk-server/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/sdk-server/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "server", - "pages": ["sdks/sdk-server/index/server/readme"] - }, - { - "group": "signWithApiKey", - "pages": [ - "sdks/sdk-server/index/signWithApiKey/readme" - ] - } - ] - }, - "sdks/sdk-server/readme" - ] - }, - { - "group": "solana", + "group": "Features", "pages": [ + "embedded-wallets/features/overview", + "reference/embedded-wallet-kit", { - "group": "documents", + "group": "Authentication", "pages": [ + "authentication/overview", + "authentication/email", + "authentication/social-logins", + "authentication/sms", { - "group": "docs", - "pages": ["sdks/solana/documents/docs/readme"] - } + "group": "Passkeys", + "pages": [ + "authentication/passkeys/introduction", + "authentication/passkeys/integration", + "authentication/passkeys/options", + "authentication/passkeys/native", + "authentication/passkeys/discoverable-vs-non-discoverable" + ] + }, + "authentication/backend-setup", + "authentication/proxying-signed-requests", + "authentication/credentials" ] }, + "products/embedded-wallets/features/multi-chain-support", + "authentication/sessions", + "reference/solana-gasless-transactions", + "reference/tron-gasless-transactions", { - "group": "index", + "group": "Wallets", "pages": [ - { - "group": "TurnkeySigner", - "pages": ["sdks/solana/index/TurnkeySigner/readme"] - }, - "sdks/solana/index/readme" + "wallets/pregenerated-wallets", + "wallets/claim-links", + "reference/aa-wallets", + "wallets/import-wallets", + "wallets/export-wallets", + "wallets/wagmi" ] - }, - "sdks/solana/readme" + } ] }, { - "group": "telegram-cloud-storage-stamper", + "group": "SDKs", "pages": [ - { - "group": "index", - "pages": [ - { - "group": "CloudStorageAPIKey", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/CloudStorageAPIKey/readme" - ] - }, - { - "group": "DEFAULT_TURNKEY_CLOUD_STORAGE_KEY", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/DEFAULT_TURNKEY_CLOUD_STORAGE_KEY/readme" - ] - }, - { - "group": "TTelegramCloudStorageStamperConfig", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/TTelegramCloudStorageStamperConfig/readme" - ] - }, - { - "group": "TelegramCloudStorageStamper", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/TelegramCloudStorageStamper/readme" - ] - }, - "sdks/telegram-cloud-storage-stamper/index/readme" - ] - }, - "sdks/telegram-cloud-storage-stamper/readme" + "sdks/react/landing", + "sdks/react-native", + "sdks/flutter", + "sdks/swift", + "sdks/typescript-frontend/landing", + "sdks/javascript-server" ] }, { - "group": "viem", + "group": "Examples", "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/viem/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TTurnkeyActivityErrorType", - "pages": [ - "sdks/viem/index/TTurnkeyActivityErrorType/readme" - ] - }, - { - "group": "TTurnkeyConsensusNeededErrorType", - "pages": [ - "sdks/viem/index/TTurnkeyConsensusNeededErrorType/readme" - ] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/viem/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyConsensusNeededError", - "pages": [ - "sdks/viem/index/TurnkeyConsensusNeededError/readme" - ] - }, - { - "group": "createAccount", - "pages": ["sdks/viem/index/createAccount/readme"] - }, - { - "group": "createAccountWithAddress", - "pages": [ - "sdks/viem/index/createAccountWithAddress/readme" - ] - }, - { - "group": "createApiKeyAccount", - "pages": [ - "sdks/viem/index/createApiKeyAccount/readme" - ] - }, - { - "group": "isTurnkeyActivityConsensusNeededError", - "pages": [ - "sdks/viem/index/isTurnkeyActivityConsensusNeededError/readme" - ] - }, - { - "group": "isTurnkeyActivityError", - "pages": [ - "sdks/viem/index/isTurnkeyActivityError/readme" - ] - }, - "sdks/viem/index/readme", - { - "group": "serializeSignature", - "pages": [ - "sdks/viem/index/serializeSignature/readme" - ] - }, - { - "group": "signMessage", - "pages": ["sdks/viem/index/signMessage/readme"] - }, - { - "group": "signTransaction", - "pages": ["sdks/viem/index/signTransaction/readme"] - }, - { - "group": "signTypedData", - "pages": ["sdks/viem/index/signTypedData/readme"] - } - ] - }, - "sdks/viem/readme" + "category/code-examples", + "embedded-wallets/code-examples/create-sub-org-passkey", + "embedded-wallets/code-examples/authenticate-user-passkey", + "embedded-wallets/code-examples/create-passkey-session", + "embedded-wallets/code-examples/create-user-email", + "embedded-wallets/code-examples/authenticate-user-email", + "embedded-wallets/code-examples/email-recovery", + "embedded-wallets/code-examples/add-credential", + "embedded-wallets/code-examples/wallet-auth", + "embedded-wallets/code-examples/signing-transactions", + "embedded-wallets/code-examples/import", + "embedded-wallets/code-examples/export" + ] + } + ] + }, + { + "group": "Transaction Automation", + "pages": [ + "signing-automation/overview", + { + "group": "Features", + "pages": [ + "products/transaction-automation/features/multi-chain-support", + "signing-automation/co-signing-transactions", + "products/transaction-automation/features/import-wallets", + "products/transaction-automation/features/export-wallets", + "developer-reference/webhooks" ] }, { - "group": "wallet-stamper", + "group": "SDKs", "pages": [ - { - "group": "WalletStamper", - "pages": ["sdks/wallet-stamper/WalletStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "BaseEthereumWallet", - "pages": [ - "sdks/wallet-stamper/index/BaseEthereumWallet/readme" - ] - }, - { - "group": "BaseWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/BaseWalletInterface/readme" - ] - }, - { - "group": "EthereumWallet", - "pages": [ - "sdks/wallet-stamper/index/EthereumWallet/readme" - ] - }, - { - "group": "EthereumWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/EthereumWalletInterface/readme" - ] - }, - { - "group": "SIGNATURE_SCHEME_TK_API_ED25519", - "pages": [ - "sdks/wallet-stamper/index/SIGNATURE_SCHEME_TK_API_ED25519/readme" - ] - }, - { - "group": "SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191", - "pages": [ - "sdks/wallet-stamper/index/SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191/readme" - ] - }, - { - "group": "STAMP_HEADER_NAME", - "pages": [ - "sdks/wallet-stamper/index/STAMP_HEADER_NAME/readme" - ] - }, - { - "group": "SolanaWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/SolanaWalletInterface/readme" - ] - }, - { - "group": "TStamp", - "pages": ["sdks/wallet-stamper/index/TStamp/readme"] - }, - { - "group": "TStamper", - "pages": [ - "sdks/wallet-stamper/index/TStamper/readme" - ] - }, - { - "group": "WalletInterface", - "pages": [ - "sdks/wallet-stamper/index/WalletInterface/readme" - ] - }, - { - "group": "WalletStamper", - "pages": [ - "sdks/wallet-stamper/index/WalletStamper/readme" - ] - }, - { - "group": "WalletStamperError", - "pages": [ - "sdks/wallet-stamper/index/WalletStamperError/readme" - ] - }, - { - "group": "WalletType", - "pages": [ - "sdks/wallet-stamper/index/WalletType/readme" - ] - }, - { - "group": "getCompressedPublicKey", - "pages": [ - "sdks/wallet-stamper/index/getCompressedPublicKey/readme" - ] - }, - "sdks/wallet-stamper/index/readme" - ] - }, - "sdks/wallet-stamper/readme" + "sdks/golang", + "sdks/ruby", + "sdks/rust", + "sdks/python", + "sdks/javascript-server" ] }, { - "group": "webauthn-stamper", + "group": "Examples", "pages": [ - { - "group": "WebauthnStamper", - "pages": [ - "sdks/webauthn-stamper/WebauthnStamper/readme" - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TWebauthnStamperConfig", - "pages": [ - "sdks/webauthn-stamper/index/TWebauthnStamperConfig/readme" - ] - }, - { - "group": "WebauthnStamper", - "pages": [ - "sdks/webauthn-stamper/index/WebauthnStamper/readme" - ] - }, - "sdks/webauthn-stamper/index/readme" - ] - }, - "sdks/webauthn-stamper/readme" + "category/code-examples-1", + "signing-automation/code-examples/signing-transactions" ] } ] + } + ] + }, + { + "group": "Crypto Ecosystems", + "pages": [ + "networks/overview", + { + "group": "Supported Networks", + "pages": [ + "networks/ethereum", + "networks/solana", + "networks/bitcoin", + "networks/cosmos", + "networks/tron", + "networks/sui", + "networks/sei", + "networks/stacks", + "networks/aptos", + "networks/movement", + "networks/others" + ] + } + ] + }, + { + "group": "Developers", + "pages": [ + "getting-started/examples", + "developer-reference/using-llms", + { + "group": "API Overview", + "pages": [ + "developer-reference/api-overview/intro", + "developer-reference/api-overview/stamps", + "developer-reference/api-overview/queries", + "developer-reference/api-overview/submissions", + "developer-reference/api-overview/errors" + ] + }, + { + "group": "Policies", + "pages": [ + "concepts/policies/quickstart", + "concepts/policies/language", + "concepts/policies/examples", + "concepts/policies/delegated-access", + "concepts/policies/smart-contract-interfaces" + ] }, + "faq" + ] + } + ] + }, + { + "tab": "SDK Reference", + "groups": [ + { + "group": "SDK Reference", + "pages": [ "sdks/introduction", - "sdks/javascript-browser", - "sdks/javascript-server", - "sdks/react", + { + "group": "React", + "pages": [ + "sdks/react/index", + "sdks/react/getting-started", + "sdks/react/auth", + "sdks/react/using-embedded-wallets", + "sdks/react/using-external-wallets", + "sdks/react/signing", + "sdks/react/ui-customization", + "sdks/react/sub-organization-customization", + "sdks/react/advanced-api-requests", + "sdks/react/advanced-backend-authentication", + "sdks/react/troubleshooting", + "sdks/react/migrating-sdk-react", + "sdks/react/legacy", + { + "group": "SDK Reference", + "pages": [ + "generated-docs/formatted/react-wallet-kit/client-context-type-add-oauth-provider", + "generated-docs/formatted/react-wallet-kit/client-context-type-add-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-clear-all-sessions", + "generated-docs/formatted/react-wallet-kit/client-context-type-clear-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-clear-unused-key-pairs", + "generated-docs/formatted/react-wallet-kit/client-context-type-complete-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-complete-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-connect-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-api-key-pair", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet-accounts", + "generated-docs/formatted/react-wallet-kit/client-context-type-delete-sub-organization", + "generated-docs/formatted/react-wallet-kit/client-context-type-disconnect-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-export-private-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-fetch-user", + "generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallet-accounts", + "generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallets", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-active-session-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-all-sessions", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-proxy-auth-config", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-wallet-providers", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-oauth-provider", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-apple-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-private-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-facebook-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-google-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-import-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-link-external-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-login", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-oauth-provider", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-sign-message", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-name", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-import-private-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-import-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-init-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-or-signup-with-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-logout", + "generated-docs/formatted/react-wallet-kit/client-context-type-refresh-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-refresh-user", + "generated-docs/formatted/react-wallet-kit/client-context-type-refresh-wallets", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-oauth-providers", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-passkeys", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-set-active-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-and-send-transaction", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-message", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-transaction", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-store-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-provider-chain", + "generated-docs/formatted/react-wallet-kit/client-context-type-update-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-update-user-name", + "generated-docs/formatted/react-wallet-kit/client-context-type-update-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-verify-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-account-chain" + ] + } + ] + }, "sdks/react-native", - "sdks/golang", - "sdks/rust", - "sdks/Ruby", - "sdks/cli", "sdks/flutter", - "sdks/migration-path", { "group": "Swift", "pages": [ @@ -2103,6 +344,84 @@ "sdks/swift/register-passkey" ] }, + { + "group": "TypeScript | Frontend", + "pages": [ + "sdks/typescript-frontend/index", + "sdks/typescript-frontend/getting-started", + "sdks/typescript-frontend/auth", + "sdks/typescript-frontend/advanced-backend-authentication", + "sdks/typescript-frontend/advanced-api-requests", + "sdks/typescript-frontend/legacy", + { + "group": "SDK Reference", + "pages": [ + "generated-docs/formatted/core/turnkey-client-add-oauth-provider", + "generated-docs/formatted/core/turnkey-client-add-passkey", + "generated-docs/formatted/core/turnkey-client-clear-all-sessions", + "generated-docs/formatted/core/turnkey-client-clear-session", + "generated-docs/formatted/core/turnkey-client-clear-unused-key-pairs", + "generated-docs/formatted/core/turnkey-client-complete-oauth", + "generated-docs/formatted/core/turnkey-client-complete-otp", + "generated-docs/formatted/core/turnkey-client-connect-wallet-account", + "generated-docs/formatted/core/turnkey-client-constructor", + "generated-docs/formatted/core/turnkey-client-create-api-key-pair", + "generated-docs/formatted/core/turnkey-client-create-passkey", + "generated-docs/formatted/core/turnkey-client-create-wallet", + "generated-docs/formatted/core/turnkey-client-create-wallet-accounts", + "generated-docs/formatted/core/turnkey-client-delete-sub-organization", + "generated-docs/formatted/core/turnkey-client-disconnect-wallet-account", + "generated-docs/formatted/core/turnkey-client-export-private-key", + "generated-docs/formatted/core/turnkey-client-export-wallet", + "generated-docs/formatted/core/turnkey-client-export-wallet-account", + "generated-docs/formatted/core/turnkey-client-fetch-user", + "generated-docs/formatted/core/turnkey-client-fetch-wallet-accounts", + "generated-docs/formatted/core/turnkey-client-fetch-wallets", + "generated-docs/formatted/core/turnkey-client-get-active-session-key", + "generated-docs/formatted/core/turnkey-client-get-all-sessions", + "generated-docs/formatted/core/turnkey-client-get-proxy-auth-config", + "generated-docs/formatted/core/turnkey-client-get-session", + "generated-docs/formatted/core/turnkey-client-get-wallet-providers", + "generated-docs/formatted/core/turnkey-client-import-private-key", + "generated-docs/formatted/core/turnkey-client-import-wallet", + "generated-docs/formatted/core/turnkey-client-init", + "generated-docs/formatted/core/turnkey-client-init-otp", + "generated-docs/formatted/core/turnkey-client-login-or-signup-with-wallet", + "generated-docs/formatted/core/turnkey-client-login-with-oauth", + "generated-docs/formatted/core/turnkey-client-login-with-otp", + "generated-docs/formatted/core/turnkey-client-login-with-passkey", + "generated-docs/formatted/core/turnkey-client-login-with-wallet", + "generated-docs/formatted/core/turnkey-client-logout", + "generated-docs/formatted/core/turnkey-client-refresh-session", + "generated-docs/formatted/core/turnkey-client-remove-oauth-providers", + "generated-docs/formatted/core/turnkey-client-remove-passkeys", + "generated-docs/formatted/core/turnkey-client-remove-user-email", + "generated-docs/formatted/core/turnkey-client-remove-user-phone-number", + "generated-docs/formatted/core/turnkey-client-set-active-session", + "generated-docs/formatted/core/turnkey-client-sign-and-send-transaction", + "generated-docs/formatted/core/turnkey-client-sign-message", + "generated-docs/formatted/core/turnkey-client-sign-transaction", + "generated-docs/formatted/core/turnkey-client-sign-up-with-oauth", + "generated-docs/formatted/core/turnkey-client-sign-up-with-otp", + "generated-docs/formatted/core/turnkey-client-sign-up-with-passkey", + "generated-docs/formatted/core/turnkey-client-sign-up-with-wallet", + "generated-docs/formatted/core/turnkey-client-store-session", + "generated-docs/formatted/core/turnkey-client-switch-wallet-provider-chain", + "generated-docs/formatted/core/turnkey-client-update-user-email", + "generated-docs/formatted/core/turnkey-client-update-user-name", + "generated-docs/formatted/core/turnkey-client-update-user-phone-number", + "generated-docs/formatted/core/turnkey-client-verify-otp", + "generated-docs/formatted/core/turnkey-client-switch-wallet-account-chain" + ] + } + ] + }, + "sdks/javascript-server", + "sdks/golang", + "sdks/rust", + "sdks/ruby", + "sdks/cli", + "sdks/python", { "group": "Web3 Libraries", "pages": [ @@ -2124,7 +443,126 @@ "sdks/advanced/webauthn-stamper", "sdks/advanced/iframe-stamper" ] - } + }, + "sdks/migration-path" + ] + } + ] + }, + { + "tab": "API Reference", + "pages": [ + "api-reference/overview", + { + "group": "Activities", + "pages": [ + "api-reference/activities/overview", + "api-reference/activities/approve-activity", + "api-reference/activities/create-api-keys", + "api-reference/activities/create-authenticators", + "api-reference/activities/create-invitations", + "api-reference/activities/create-oauth-providers", + "api-reference/activities/create-policies", + "api-reference/activities/create-policy", + "api-reference/activities/create-private-key-tag", + "api-reference/activities/create-private-keys", + "api-reference/activities/create-read-only-session", + "api-reference/activities/create-read-write-session", + "api-reference/activities/create-sub-organization", + "api-reference/activities/create-user-tag", + "api-reference/activities/create-users", + "api-reference/activities/create-wallet", + "api-reference/activities/create-wallet-accounts", + "api-reference/activities/delete-api-keys", + "api-reference/activities/delete-authenticators", + "api-reference/activities/delete-invitation", + "api-reference/activities/delete-oauth-providers", + "api-reference/activities/delete-policy", + "api-reference/activities/delete-private-key-tags", + "api-reference/activities/delete-private-keys", + "api-reference/activities/delete-sub-organization", + "api-reference/activities/delete-user-tags", + "api-reference/activities/delete-users", + "api-reference/activities/delete-wallets", + "api-reference/activities/export-private-key", + "api-reference/activities/export-wallet", + "api-reference/activities/export-wallet-account", + "api-reference/activities/import-private-key", + "api-reference/activities/import-wallet", + "api-reference/activities/init-email-recovery", + "api-reference/activities/init-generic-otp", + "api-reference/activities/init-import-private-key", + "api-reference/activities/init-import-wallet", + "api-reference/activities/init-otp-auth", + "api-reference/activities/login-with-a-stamp", + "api-reference/activities/login-with-oauth", + "api-reference/activities/login-with-otp", + "api-reference/activities/oauth", + "api-reference/activities/otp-auth", + "api-reference/activities/perform-email-auth", + "api-reference/activities/recover-a-user", + "api-reference/activities/reject-activity", + "api-reference/activities/remove-organization-feature", + "api-reference/activities/set-organization-feature", + "api-reference/activities/sign-raw-payload", + "api-reference/activities/sign-raw-payloads", + "api-reference/activities/sign-transaction", + "api-reference/activities/update-policy", + "api-reference/activities/update-private-key-tag", + "api-reference/activities/update-root-quorum", + "api-reference/activities/update-user", + "api-reference/activities/update-user-tag", + "api-reference/activities/update-wallet", + "api-reference/activities/verify-generic-otp" + ] + }, + { + "group": "Queries", + "pages": [ + "api-reference/queries/overview", + "api-reference/queries/get-activity", + "api-reference/queries/get-api-key", + "api-reference/queries/get-api-keys", + "api-reference/queries/get-authenticator", + "api-reference/queries/get-authenticators", + "api-reference/queries/get-configs", + "api-reference/queries/get-oauth-providers", + "api-reference/queries/get-policy", + "api-reference/queries/get-private-key", + "api-reference/queries/get-suborgs", + "api-reference/queries/get-user", + "api-reference/queries/get-verified-suborgs", + "api-reference/queries/get-wallet", + "api-reference/queries/get-wallet-account", + "api-reference/queries/list-activities", + "api-reference/queries/list-policies", + "api-reference/queries/list-private-key-tags", + "api-reference/queries/list-private-keys", + "api-reference/queries/list-user-tags", + "api-reference/queries/list-users", + "api-reference/queries/list-wallets", + "api-reference/queries/list-wallets-accounts", + "api-reference/queries/who-am-i" + ] + } + ] + }, + { + "tab": "Security", + "pages": [ + { + "group": "Security", + "pages": [ + "category/security", + "security/our-approach", + "security/non-custodial-key-mgmt", + "security/secure-enclaves", + "security/quorum-deployments", + "security/verifiable-data", + "security/disaster-recovery", + "security/enclave-secure-channels", + "security/whitepaper", + "security/reporting-a-vulnerability" ] } ] @@ -2157,13 +595,244 @@ "changelogs/wallet-stamper/readme", "changelogs/webauthn-stamper/readme", "changelogs/golang/readme", - "changelogs/dart/readme" + "changelogs/dart/readme", + "changelogs/core/readme", + "changelogs/react-wallet-kit/readme" ] } ] } ] } - ] - } + ], + "global": { + "anchors": [ + { + "anchor": "Support", + "href": "https://join.slack.com/t/clubturnkey/shared_invite/zt-31v4yhgw6-PwBzyNsWCCBTk2xft3EoHQ", + "icon": "slack" + }, + { + "anchor": "Blog", + "href": "https://www.turnkey.com/blog", + "icon": "newspaper" + }, + { + "anchor": "Contact Us", + "href": "https://www.turnkey.com/contact-us", + "icon": "headset" + } + ] + } + }, + "logo": { + "light": "/logo/light.svg", + "dark": "/logo/dark.svg", + "href": "https://www.turnkey.com/" + }, + "styling": { + "codeblocks": "system" + }, + "navbar": { + "links": [ + { + "label": "Demo", + "href": "https://wallets.turnkey.com/" + }, + { + "label": "Login", + "href": "https://app.turnkey.com/dashboard/auth/login?step=1" + } + ], + "primary": { + "type": "button", + "label": "Get Started", + "href": "https://app.turnkey.com/dashboard/auth/initial" + } + }, + "footer": { + "socials": { + "x": "https://x.com/turnkeyhq", + "github": "https://github.com/tkhq", + "slack": "https://join.slack.com/t/clubturnkey/shared_invite/zt-31v4yhgw6-PwBzyNsWCCBTk2xft3EoHQ", + "linkedin": "https://www.linkedin.com/company/turnkeyhq/" + } + }, + "redirects": [ + { + "source": "/users/sessions", + "destination": "/features/sessions", + "permanent": true + }, + { + "source": "/users/:slug*", + "destination": "/concepts/users/:slug*", + "permanent": true + }, + { + "source": "/api-introduction", + "destination": "/developer-reference/api-overview/intro", + "permanent": true + }, + { + "source": "/api-design/:slug*", + "destination": "/api-overview/:slug*", + "permanent": true + }, + { + "source": "/managing-policies/:slug*", + "destination": "/concepts/policies/:slug*", + "permanent": true + }, + { + "source": "/managing-users/:slug*", + "destination": "/concepts/users/:slug*", + "permanent": true + }, + { + "source": "/getting-started/email-auth", + "destination": "/features/email-auth", + "permanent": true + }, + { + "source": "/concepts/email-auth", + "destination": "/features/email-auth", + "permanent": true + }, + { + "source": "/concepts/email-recovery", + "destination": "/features/email-recovery", + "permanent": true + }, + { + "source": "/integration-guides/export-wallets", + "destination": "/features/export-wallets", + "permanent": true + }, + { + "source": "/integration-guides/import-wallets", + "destination": "/features/import-wallets", + "permanent": true + }, + { + "source": "/integration-guides/aa-wallets", + "destination": "/reference/aa-wallets", + "permanent": true + }, + { + "source": "/integration-guides/sub-organization-auth", + "destination": "/embedded-wallets/sub-organization-auth", + "permanent": true + }, + { + "source": "/integration-guides/sub-organization-recovery", + "destination": "/embedded-wallets/sub-organization-recovery", + "permanent": true + }, + { + "source": "/integration-guides/sub-organizations-as-wallets", + "destination": "/embedded-wallets/sub-organizations-as-wallets", + "permanent": true + }, + { + "source": "/integration-guides/webhooks", + "destination": "/features/webhooks", + "permanent": true + }, + { + "source": "/reference/react-components", + "destination": "/reference/embedded-wallet-kit", + "permanent": true + }, + { + "source": "/getting-started/resource-limits", + "destination": "/concepts/resource-limits", + "permanent": true + }, + { + "source": "/ecosystem-integrations/ethereum", + "destination": "/ecosystems/ethereum", + "permanent": true + }, + { + "source": "/ecosystem-integrations/solana", + "destination": "/ecosystems/solana", + "permanent": true + }, + { + "source": "/ecosystem-integrations/bitcoin", + "destination": "/ecosystems/bitcoin", + "permanent": true + }, + { + "source": "/ecosystem-integrations/index", + "destination": "/ecosystems/overview", + "permanent": true + }, + { + "source": "/passkeys/discoverable-vs-non-discoverable", + "destination": "/authentication/passkeys/discoverable-vs-non-discoverable", + "permanent": true + }, + { + "source": "/passkeys/integration", + "destination": "/authentication/passkeys/integration", + "permanent": true + }, + { + "source": "/passkeys/introduction", + "destination": "/authentication/passkeys/introduction", + "permanent": true + }, + { + "source": "/passkeys/native", + "destination": "/authentication/passkeys/native", + "permanent": true + }, + { + "source": "/passkeys/options", + "destination": "/authentication/passkeys/options", + "permanent": true + }, + { + "source": "/features/oauth", + "destination": "/authentication/social-logins", + "permanent": true + }, + { + "source": "/concepts/introduction", + "destination": "/concepts/overview", + "permanent": true + }, + { + "source": "/features/email-auth", + "destination": "/authentication/email", + "permanent": true + }, + { + "source": "/features/email-recovery", + "destination": "/authentication/email", + "permanent": true + }, + { + "source": "/api-overview/:slug*", + "destination": "/developer-reference/api-overview/:slug*", + "permanent": true + }, + { + "source": "/ecosystems/:slug*", + "destination": "/networks/:slug*", + "permanent": true + }, + { + "source": "/sdks/react/sdk-reference", + "destination": "/generated-docs/formatted/react-wallet-kit/client-context-type-add-oauth-provider", + "permanent": false + }, + { + "source": "/sdks/typescript-frontend/sdk-reference", + "destination": "/generated-docs/formatted/core/turnkey-client-add-oauth-provider", + "permanent": false + } + ] } diff --git a/generated-docs/formatted/core/turnkey-client-add-oauth-provider.mdx b/generated-docs/formatted/core/turnkey-client-add-oauth-provider.mdx new file mode 100644 index 000000000..ea7518267 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-add-oauth-provider.mdx @@ -0,0 +1,49 @@ +--- +title: "addOauthProvider()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Adds an OAuth provider to the user. + + + +

Package: core

+ +

Defined in: core.ts:2582

+ + + + + + +OIDC token for the OAuth provider. + + +name of the OAuth provider to add (e.g., "Google", "Apple"). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to add the provider for a specific user (defaults to current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of provider IDs associated with the user. + diff --git a/generated-docs/formatted/core/turnkey-client-add-passkey.mdx b/generated-docs/formatted/core/turnkey-client-add-passkey.mdx new file mode 100644 index 000000000..48fd9fca6 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-add-passkey.mdx @@ -0,0 +1,48 @@ +--- +title: "addPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Adds a new passkey authenticator for the user. + +
    +
  • This function prompts the user to create a new passkey (WebAuthn/FIDO2) and adds it as an authenticator for the user.
  • +
  • Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow.
  • +
  • If a userId is provided, the passkey is added for that specific user; otherwise, it uses the current session's userId.
  • +
  • The passkey's name and display name can be customized; if not provided, defaults are generated.
  • +
  • The resulting passkey attestation and challenge are registered with Turnkey as a new authenticator.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2741

+ + + + + + +display name of the passkey (defaults to the value of `name`). + + +name of the passkey (defaults to "Turnkey Passkey-`timestamp`"). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to add the passkey for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of authenticator IDs for the newly added passkey(s). + diff --git a/generated-docs/formatted/core/turnkey-client-clear-all-sessions.mdx b/generated-docs/formatted/core/turnkey-client-clear-all-sessions.mdx new file mode 100644 index 000000000..22b5fd153 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-clear-all-sessions.mdx @@ -0,0 +1,32 @@ +--- +title: "clearAllSessions()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Clears all sessions and resets the active session state. + +
    +
  • This function removes all session data from the client and persistent storage, including all associated key pairs.
  • +
  • Iterates through all stored session keys, clearing each session and deleting its corresponding API key pair.
  • +
  • After clearing, there will be no active session, and all session-related data will be removed from local storage.
  • +
  • Throws an error if no sessions exist or if there is an error during the clearing process.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3446

+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves when all sessions are successfully cleared. + diff --git a/generated-docs/formatted/core/turnkey-client-clear-session.mdx b/generated-docs/formatted/core/turnkey-client-clear-session.mdx new file mode 100644 index 000000000..ba5defcfd --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-clear-session.mdx @@ -0,0 +1,38 @@ +--- +title: "clearSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Clears the session associated with the specified session key, or the active session by default. + +
    +
  • This function deletes the session and its associated key pair from storage.
  • +
  • If a sessionKey is provided, it will clear the session under that key; otherwise, it will clear the default (active) session.
  • +
  • Removes the session data from local storage and deletes the corresponding API key pair from the key store.
  • +
  • Throws an error if the session does not exist or if there is an error during the clearing process.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3413

+ + + + + + +session key to clear the session under (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the session is successfully cleared. + diff --git a/generated-docs/formatted/core/turnkey-client-clear-unused-key-pairs.mdx b/generated-docs/formatted/core/turnkey-client-clear-unused-key-pairs.mdx new file mode 100644 index 000000000..7a077b18f --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-clear-unused-key-pairs.mdx @@ -0,0 +1,32 @@ +--- +title: "clearUnusedKeyPairs()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Clears any unused API key pairs from persistent storage. + +
    +
  • This function scans all API key pairs stored in indexedDB and removes any key pairs that are not associated with a session in persistent storage.
  • +
  • Ensures that only key pairs referenced by existing sessions are retained, preventing orphaned or stale key pairs from accumulating.
  • +
  • Iterates through all stored session keys and builds a map of in-use public keys, then deletes any key pairs not present in this map.
  • +
  • Intended to be called after session changes (e.g., login, logout, session replacement) to keep key storage clean and secure.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3680

+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves when all unused key pairs are successfully cleared. + diff --git a/generated-docs/formatted/core/turnkey-client-complete-oauth.mdx b/generated-docs/formatted/core/turnkey-client-complete-oauth.mdx new file mode 100644 index 000000000..fd45e9b41 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-complete-oauth.mdx @@ -0,0 +1,54 @@ +--- +title: "completeOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Completes the OAuth authentication flow by either signing up or logging in the user, depending on whether a sub-organization already exists for the provided OIDC token. + +
    +
  • This function first checks if there is an existing sub-organization associated with the OIDC token.
  • +
  • If a sub-organization exists, it proceeds with the OAuth login flow.
  • +
  • If no sub-organization exists, it creates a new sub-organization and completes the sign-up flow.
  • +
  • Optionally accepts a custom OAuth provider name, session key, and additional sub-organization creation parameters.
  • +
  • Handles session storage and management, and supports invalidating existing sessions if specified.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1449

+ + + + + + +parameters for sub-organization creation (e.g., authenticators, user metadata). + + +flag to invalidate existing sessions for the user. + + +OIDC token received after successful authentication with the OAuth provider. + + +name of the OAuth provider (defaults to a generated name with a timestamp). + + +public key to use for authentication. Must be generated prior to calling this function. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the user. + diff --git a/generated-docs/formatted/core/turnkey-client-complete-otp.mdx b/generated-docs/formatted/core/turnkey-client-complete-otp.mdx new file mode 100644 index 000000000..aab5a64e9 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-complete-otp.mdx @@ -0,0 +1,60 @@ +--- +title: "completeOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Completes the OTP authentication flow by verifying the OTP code and then either signing up or logging in the user. + +
    +
  • This function first verifies the OTP code for the provided contact and OTP type.
  • +
  • If the contact is not associated with an existing sub-organization, it will automatically create a new sub-organization and complete the sign-up flow.
  • +
  • If the contact is already associated with a sub-organization, it will complete the login flow.
  • +
  • Supports passing a custom public key for authentication, invalidating existing session, specifying a session key, and providing additional sub-organization creation parameters.
  • +
  • Handles both email and SMS OTP types.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1367

+ + + + + + +contact information for the user (e.g., email address or phone number). + + +parameters for sub-organization creation (e.g., authenticators, user metadata). + + +flag to invalidate existing sessions for the user. + + +OTP code entered by the user. + + +ID of the OTP to complete (returned from `initOtp`). + + +type of OTP being completed (OtpType.Email or OtpType.Sms). + + +public key to use for authentication. If not provided, a new key pair may be generated. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the user. + diff --git a/generated-docs/formatted/core/turnkey-client-connect-wallet-account.mdx b/generated-docs/formatted/core/turnkey-client-connect-wallet-account.mdx new file mode 100644 index 000000000..524a9b83c --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-connect-wallet-account.mdx @@ -0,0 +1,31 @@ +--- +title: "connectWalletAccount()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Connects the specified wallet account. + +
    +
  • Requires the wallet manager and its connector to be initialized.
  • +
+ +

Package: core

+ +

Defined in: core.ts:532

+ + + + + wallet provider to connect. + + + +A successful response returns the following fields: + + + A promise that resolves once the wallet account is connected. + diff --git a/generated-docs/formatted/core/turnkey-client-constructor.mdx b/generated-docs/formatted/core/turnkey-client-constructor.mdx new file mode 100644 index 000000000..26d2e4d4b --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-constructor.mdx @@ -0,0 +1,25 @@ +--- +title: "constructor()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: core

+ +

Defined in: core.ts:109

+ + + + + + + + + + + + +A successful response returns the following fields: + + diff --git a/generated-docs/formatted/core/turnkey-client-create-api-key-pair.mdx b/generated-docs/formatted/core/turnkey-client-create-api-key-pair.mdx new file mode 100644 index 000000000..b45e1e66c --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-create-api-key-pair.mdx @@ -0,0 +1,41 @@ +--- +title: "createApiKeyPair()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Creates a new API key pair and returns the public key. + +
    +
  • This function generates a new API key pair and stores it in the underlying key store (IndexedDB).
  • +
  • If an external key pair is provided, it will use that key pair for creation instead of generating a new one.
  • +
  • If ``storeOverride`` is set to true, the generated or provided public key will be set as the override key in the API key stamper, making it the active key for subsequent signing operations.
  • +
  • Ensures the API key stamper is initialized before proceeding.
  • +
  • Handles both native CryptoKeyPair objects and raw key material.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3732

+ + + + + + +An externally generated key pair (either a CryptoKeyPair or an object with publicKey/privateKey strings) to use instead of generating a new one. + + +If true, sets the generated or provided public key as the override key in the API key stamper (defaults to false). +@returnparams.s A promise that resolves to the public key of the created or provided API key pair as a string. + + + + + +A successful response returns the following fields: + + diff --git a/generated-docs/formatted/core/turnkey-client-create-passkey.mdx b/generated-docs/formatted/core/turnkey-client-create-passkey.mdx new file mode 100644 index 000000000..7975c308a --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-create-passkey.mdx @@ -0,0 +1,49 @@ +--- +title: "createPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Creates a new passkey authenticator for the user. + +
    +
  • This function generates a new passkey attestation and challenge, suitable for registration with the user's device.
  • +
  • Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow.
  • +
  • The resulting attestation and challenge can be used to register the passkey with Turnkey.
  • +
+ +

Package: core

+ +

Defined in: core.ts:182

+ + + + + + +display name for the passkey. If not provided, defaults to "A Passkey". + + +name of the passkey. If not provided, defaults to "A Passkey". + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an object containing: + - attestation: attestation object returned from the passkey creation process. + - encodedChallenge: encoded challenge string used for passkey registration. + + + + + diff --git a/generated-docs/formatted/core/turnkey-client-create-wallet-accounts.mdx b/generated-docs/formatted/core/turnkey-client-create-wallet-accounts.mdx new file mode 100644 index 000000000..e58ff7520 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-create-wallet-accounts.mdx @@ -0,0 +1,49 @@ +--- +title: "createWalletAccounts()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Creates new accounts in the specified wallet. + +
    +
  • This function creates new wallet accounts based on the provided account parameters or address formats.
  • +
  • If a walletId is provided, it creates the accounts in that specific wallet; otherwise, it uses the current session's wallet.
  • +
  • If a list of address formats is provided, it will create accounts in the wallet based on those formats, automatically determining the next available path indexes to avoid duplicates with existing accounts.
  • +
  • If account parameters are provided, they are used directly for account creation.
  • +
  • Automatically queries existing wallet accounts to prevent duplicate account creation for the same address format and path.
  • +
  • Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:2945

+ + + + + + +An array of account parameters or address formats to create in the wallet. + + +organization ID to create the accounts under a specific organization (walletId must be associated with the sub-organization). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +ID of the wallet to create accounts in. + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of addresses for the newly created accounts. + diff --git a/generated-docs/formatted/core/turnkey-client-create-wallet.mdx b/generated-docs/formatted/core/turnkey-client-create-wallet.mdx new file mode 100644 index 000000000..b914d0a27 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-create-wallet.mdx @@ -0,0 +1,53 @@ +--- +title: "createWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Creates a new wallet for sub-organization. + +
    +
  • This function creates a new wallet for the current sub-organization.
  • +
  • If an organizationId is provided, the wallet will be created under that specific sub-organization; otherwise, it uses the current session's organizationId.
  • +
  • If a list of address formats is provided, accounts will be created in the wallet based on those formats (starting from path index 0).
  • +
  • If a list of account parameters is provided, those accounts will be created in the wallet.
  • +
  • If no accounts or address formats are provided, default Ethereum and Solana accounts will be created.
  • +
  • Optionally allows specifying the mnemonic length for the wallet seed phrase (defaults to 12).
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:2872

+ + + + + + +array of account parameters or address formats to create in the wallet. + + +mnemonic length for the wallet seed phrase (defaults to 12). + + +organization ID to create the wallet under a specific sub-organization (defaults to the current session's organizationId). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +name of the wallet to create. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the ID of the newly created wallet. + diff --git a/generated-docs/formatted/core/turnkey-client-delete-sub-organization.mdx b/generated-docs/formatted/core/turnkey-client-delete-sub-organization.mdx new file mode 100644 index 000000000..2164c3186 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-delete-sub-organization.mdx @@ -0,0 +1,42 @@ +--- +title: "deleteSubOrganization()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Deletes the current sub-organization (sub-org) for the active session. + +
    +
  • This function deletes the sub-organization associated with the current active session.
  • +
  • By default, the deletion will fail if any wallets associated with the sub-organization have not been exported.
  • +
  • If ``deleteWithoutExport`` is set to true, the sub-organization will be deleted even if its wallets have not been exported (potentially resulting in loss of access to those wallets).
  • +
  • Requires an active session; otherwise, an error is thrown.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:3339

+ + + + + + +flag to delete the sub-organization without requiring all wallets to be exported first (defaults to false). + + +parameter to stamp the request with a specific stamper. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `TDeleteSubOrganizationResponse` object containing the result of the deletion. + diff --git a/generated-docs/formatted/core/turnkey-client-disconnect-wallet-account.mdx b/generated-docs/formatted/core/turnkey-client-disconnect-wallet-account.mdx new file mode 100644 index 000000000..1a8e30ebb --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-disconnect-wallet-account.mdx @@ -0,0 +1,31 @@ +--- +title: "disconnectWalletAccount()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Disconnects the specified wallet account. + +
    +
  • Requires the wallet manager and its connector to be initialized.
  • +
+ +

Package: core

+ +

Defined in: core.ts:559

+ + + + + wallet provider to disconnect. + + + +A successful response returns the following fields: + + + A promise that resolves once the wallet account is disconnected. + diff --git a/generated-docs/formatted/core/turnkey-client-export-private-key.mdx b/generated-docs/formatted/core/turnkey-client-export-private-key.mdx new file mode 100644 index 000000000..9ff035758 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-export-private-key.mdx @@ -0,0 +1,48 @@ +--- +title: "exportPrivateKey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Exports a private key as an encrypted bundle. + +
    +
  • This function exports the specified private key as an encrypted bundle, suitable for backup or transfer.
  • +
  • The exported bundle contains the private key's key material, encrypted to the provided target public key.
  • +
  • If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown.
  • +
  • If an organizationId is provided, the private key will be exported under that sub-organization; otherwise, the current session's organizationId is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:3078

+ + + + + + +organization ID to export the private key under a specific sub + + +ID of the private key to export. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +public key to encrypt the bundle to (required). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an `ExportBundle` object containing the encrypted private key and metadata. + diff --git a/generated-docs/formatted/core/turnkey-client-export-wallet-account.mdx b/generated-docs/formatted/core/turnkey-client-export-wallet-account.mdx new file mode 100644 index 000000000..a370dea44 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-export-wallet-account.mdx @@ -0,0 +1,48 @@ +--- +title: "exportWalletAccount()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Exports a wallet account as an encrypted bundle. + +
    +
  • This function exports the specified wallet account as an encrypted bundle, suitable for backup or transfer.
  • +
  • The exported bundle contains the wallet account's key material, encrypted to the provided target public key.
  • +
  • If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown.
  • +
  • If an organizationId is provided, the wallet account will be exported under that sub-organization; otherwise, the current session's organizationId is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:3134

+ + + + + + +address of the wallet account to export. + + +organization ID to export the wallet account under a specific sub-organization. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +public key to encrypt the bundle to. + + + + + +A successful response returns the following fields: + + + A promise that resolves to an `ExportBundle` object containing the encrypted wallet account and metadata. + diff --git a/generated-docs/formatted/core/turnkey-client-export-wallet.mdx b/generated-docs/formatted/core/turnkey-client-export-wallet.mdx new file mode 100644 index 000000000..fe1b2e50f --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-export-wallet.mdx @@ -0,0 +1,49 @@ +--- +title: "exportWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Exports a wallet as an encrypted bundle. + +
    +
  • This function exports the specified wallet and its accounts as an encrypted bundle, suitable for backup or transfer.
  • +
  • The exported bundle contains the wallet's seed phrase, encrypted to the provided target public key.
  • +
  • If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown.
  • +
  • If an organizationId is provided, the wallet will be exported under that sub-organization; otherwise, the current session's organizationId is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • The exported bundle can later be imported using the ``importWallet`` method.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3022

+ + + + + + +organization ID to export the wallet under a specific sub-organization (walletId must be associated with the sub-organization). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +public key to encrypt the bundle to (required). + + +ID of the wallet to export. + + + + + +A successful response returns the following fields: + + + A promise that resolves to an `ExportBundle` object containing the encrypted wallet seed phrase and metadata. + diff --git a/generated-docs/formatted/core/turnkey-client-fetch-user.mdx b/generated-docs/formatted/core/turnkey-client-fetch-user.mdx new file mode 100644 index 000000000..0724b2035 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-fetch-user.mdx @@ -0,0 +1,45 @@ +--- +title: "fetchUser()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Fetches the user details for the current session or a specified user. + +
    +
  • Retrieves user details from the Turnkey API using the provided userId and organizationId, or defaults to those from the active session.
  • +
  • If no userId is provided, the userId from the current session is used.
  • +
  • If no organizationId is provided, the organizationId from the current session is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Ensures that an active session exists before making the request.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2230

+ + + + + + +organization ID to specify the sub-organization (defaults to the current session's organizationId). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to fetch specific user details (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `v1User` object containing the user details. + diff --git a/generated-docs/formatted/core/turnkey-client-fetch-wallet-accounts.mdx b/generated-docs/formatted/core/turnkey-client-fetch-wallet-accounts.mdx new file mode 100644 index 000000000..756bd5beb --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-fetch-wallet-accounts.mdx @@ -0,0 +1,48 @@ +--- +title: "fetchWalletAccounts()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Fetches all accounts for a specific wallet, including both embedded and connected wallet accounts. + +
    +
  • For embedded wallets, retrieves accounts from the Turnkey API, supporting pagination (defaults to the first page with a limit of 100 accounts).
  • +
  • For connected wallets (e.g., browser extensions or external providers), constructs account objects for each connected address from the provided or discovered wallet providers.
  • +
  • Automatically determines the account type and populates relevant fields such as address, curve, and signing capability.
  • +
  • Optionally allows filtering by a specific set of wallet providers and supports custom pagination options.
  • +
  • Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:1787

+ + + + + + +pagination options for embedded wallets. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +wallet for which to fetch accounts. + + +list of wallet providers to filter by (used for connected wallets). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of `v1WalletAccount` objects. + diff --git a/generated-docs/formatted/core/turnkey-client-fetch-wallets.mdx b/generated-docs/formatted/core/turnkey-client-fetch-wallets.mdx new file mode 100644 index 000000000..1c2a331e3 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-fetch-wallets.mdx @@ -0,0 +1,40 @@ +--- +title: "fetchWallets()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Fetches all wallets for the current user, including both embedded and connected wallets. + +
    +
  • Retrieves all wallets associated with the organizationId from the current active session.
  • +
  • For each embedded wallet, automatically fetches and attaches all associated wallet accounts.
  • +
  • For connected wallets (e.g., browser extensions or external providers), groups providers by wallet name and attaches all connected accounts.
  • +
  • Returns both embedded and connected wallets in a single array, each with their respective accounts populated.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:1671

+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of `Wallet` objects. + diff --git a/generated-docs/formatted/core/turnkey-client-get-active-session-key.mdx b/generated-docs/formatted/core/turnkey-client-get-active-session-key.mdx new file mode 100644 index 000000000..d90e8a511 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-get-active-session-key.mdx @@ -0,0 +1,32 @@ +--- +title: "getActiveSessionKey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Retrieves the active session key currently set in persistent storage. + +
    +
  • This function fetches the session key that is currently marked as active in the client's persistent storage.
  • +
  • The active session key determines which session is used for all session-dependent operations.
  • +
  • If no active session key is set, returns ``undefined``.
  • +
  • Useful for determining which session is currently in use, especially when managing multiple sessions.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3657

+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves to the active session key as a string, or `undefined` if no active session is set. + diff --git a/generated-docs/formatted/core/turnkey-client-get-all-sessions.mdx b/generated-docs/formatted/core/turnkey-client-get-all-sessions.mdx new file mode 100644 index 000000000..c0a08bf30 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-get-all-sessions.mdx @@ -0,0 +1,32 @@ +--- +title: "getAllSessions()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Retrieves all sessions stored in persistent storage. + +
    +
  • This function fetches all session objects currently stored by the client, including those that are not active.
  • +
  • Returns a record mapping each session key to its corresponding ``Session`` object.
  • +
  • Useful for session management, auditing, or displaying all available sessions to the user.
  • +
  • Automatically skips any session keys that do not have a valid session object.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3598

+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves to a record of session keys and their corresponding `Session` objects, or `undefined` if no sessions exist. + diff --git a/generated-docs/formatted/core/turnkey-client-get-proxy-auth-config.mdx b/generated-docs/formatted/core/turnkey-client-get-proxy-auth-config.mdx new file mode 100644 index 000000000..b976e7d53 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-get-proxy-auth-config.mdx @@ -0,0 +1,36 @@ +--- +title: "getProxyAuthConfig()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Fetches the WalletKit proxy authentication configuration from the auth proxy. + +
    +
  • This function makes a request to the Turnkey auth proxy to retrieve the current WalletKit configuration,
  • +
+ +including supported authentication methods, OAuth providers, and any custom proxy settings. + +
    +
  • Useful for dynamically configuring the client UI or authentication flows based on the proxy's capabilities.
  • +
  • Ensures that the client is aware of the latest proxy-side configuration, which may affect available login/signup options.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3775

+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves to a `ProxyTGetWalletKitConfigResponse` object containing the proxy authentication configuration. + diff --git a/generated-docs/formatted/core/turnkey-client-get-session.mdx b/generated-docs/formatted/core/turnkey-client-get-session.mdx new file mode 100644 index 000000000..bb6fe9182 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-get-session.mdx @@ -0,0 +1,37 @@ +--- +title: "getSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Retrieves the session associated with the specified session key, or the active session by default. + +
    +
  • This function retrieves the session object from storage, using the provided session key or, if not specified, the current active session key.
  • +
  • If no session key is provided and there is no active session, it returns undefined.
  • +
  • Returns the session details, including public key, organization ID, user ID, and expiration.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3571

+ + + + + + +session key to retrieve a specific session (defaults to the current active session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `Session` object containing the session details, or undefined if not found. + diff --git a/generated-docs/formatted/core/turnkey-client-get-wallet-providers.mdx b/generated-docs/formatted/core/turnkey-client-get-wallet-providers.mdx new file mode 100644 index 000000000..76744319b --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-get-wallet-providers.mdx @@ -0,0 +1,32 @@ +--- +title: "getWalletProviders()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Retrieves wallet providers from the initialized wallet manager. + +
    +
  • Optionally filters providers by the specified blockchain chain.
  • +
  • Throws an error if the wallet manager is not initialized.
  • +
+ +

Package: core

+ +

Defined in: core.ts:504

+ + + + + optional blockchain chain to filter the returned providers. + + + +A successful response returns the following fields: + + + A promise that resolves to an array of wallet providers. + diff --git a/generated-docs/formatted/core/turnkey-client-import-private-key.mdx b/generated-docs/formatted/core/turnkey-client-import-private-key.mdx new file mode 100644 index 000000000..17cc5bc1c --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-import-private-key.mdx @@ -0,0 +1,54 @@ +--- +title: "importPrivateKey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Imports a private key from an encrypted bundle. + +
    +
  • This function imports a private key using the provided encrypted bundle.
  • +
  • If a userId is provided, the private key will be imported for that specific user; otherwise, it uses the current session's userId.
  • +
  • Requires address formats to
  • +
  • Automatically infers the cryptographic curve used to generate the private key based on the address format (can be optionally overriden if needed).
  • +
  • The encrypted bundle MUST be encrypted to ensure security.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:3265

+ + + + + + + +the cryptographic curve used to generate a given private key + + +encrypted bundle containing the private key key material and metadata. + + +name of the private key to create upon import. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to import the wallet for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the ID of the imported wallet. + diff --git a/generated-docs/formatted/core/turnkey-client-import-wallet.mdx b/generated-docs/formatted/core/turnkey-client-import-wallet.mdx new file mode 100644 index 000000000..39e674e82 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-import-wallet.mdx @@ -0,0 +1,52 @@ +--- +title: "importWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Imports a wallet from an encrypted bundle. + +
    +
  • This function imports a wallet using the provided encrypted bundle and creates accounts based on the provided parameters.
  • +
  • If a userId is provided, the wallet will be imported for that specific user; otherwise, it uses the current session's userId.
  • +
  • If an accounts array is provided, those accounts will be created in the imported wallet; otherwise, default Ethereum and Solana accounts will be created.
  • +
  • The encrypted bundle MUST be encrypted to
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:3191

+ + + + + + +array of account parameters to create in the imported wallet (defaults to standard Ethereum and Solana accounts). + + +encrypted bundle containing the wallet seed phrase and metadata. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to import the wallet for a specific user (defaults to the current session's userId). + + +name of the wallet to create upon import. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the ID of the imported wallet. + diff --git a/generated-docs/formatted/core/turnkey-client-init-otp.mdx b/generated-docs/formatted/core/turnkey-client-init-otp.mdx new file mode 100644 index 000000000..7878e703b --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-init-otp.mdx @@ -0,0 +1,40 @@ +--- +title: "initOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Initializes the OTP process by sending an OTP code to the provided contact. + +
    +
  • This function initiates the OTP flow by sending a one-time password (OTP) code to the user's contact information (email address or phone number) via the auth proxy.
  • +
  • Supports both email and SMS OTP types.
  • +
  • Returns an OTP ID that is required for subsequent OTP verification.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1096

+ + + + + + +contact information for the user (e.g., email address or phone number). + + +type of OTP to initialize (OtpType.Email or OtpType.Sms). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the OTP ID required for verification. + diff --git a/generated-docs/formatted/core/turnkey-client-init.mdx b/generated-docs/formatted/core/turnkey-client-init.mdx new file mode 100644 index 000000000..bfdb371d6 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-init.mdx @@ -0,0 +1,19 @@ +--- +title: "init()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: core

+ +

Defined in: core.ts:127

+ + + +

No parameters.

+ + +A successful response returns the following fields: + + diff --git a/generated-docs/formatted/core/turnkey-client-login-or-signup-with-wallet.mdx b/generated-docs/formatted/core/turnkey-client-login-or-signup-with-wallet.mdx new file mode 100644 index 000000000..346e488ba --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-login-or-signup-with-wallet.mdx @@ -0,0 +1,49 @@ +--- +title: "loginOrSignupWithWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Logs in an existing user or signs up a new user using a wallet, creating a new sub-organization if needed. + +
    +
  • This function attempts to log in the user by stamping a login request with the provided wallet.
  • +
  • If the wallet’s public key is not associated with an existing sub-organization, a new one is created.
  • +
  • Handles both wallet authentication and sub-organization creation in a single flow.
  • +
  • For Ethereum wallets, derives the public key from the signed request header; for Solana wallets, retrieves it directly from the wallet.
  • +
  • Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
+ +

Package: core

+ +

Defined in: core.ts:888

+ + + + + + +optional parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +session expiration time in seconds (defaults to the configured default). + + +session key to use for storing the session (defaults to the default session key). + + +wallet provider to use for authentication. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the sub-organization (new or existing). + diff --git a/generated-docs/formatted/core/turnkey-client-login-with-oauth.mdx b/generated-docs/formatted/core/turnkey-client-login-with-oauth.mdx new file mode 100644 index 000000000..f836d7520 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-login-with-oauth.mdx @@ -0,0 +1,47 @@ +--- +title: "loginWithOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Logs in a user using OAuth authentication. + +
    +
  • This function logs in a user using the provided OIDC token and public key.
  • +
  • Optionally invalidates any existing sessions for the user if ``invalidateExisting`` is set to true.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Handles cleanup of unused key pairs if login fails.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1521

+ + + + + + +flag to invalidate existing sessions for the user. + + +OIDC token received after successful authentication with the OAuth provider. + + +public key to use for authentication. Must be generated prior to calling this function. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token. + diff --git a/generated-docs/formatted/core/turnkey-client-login-with-otp.mdx b/generated-docs/formatted/core/turnkey-client-login-with-otp.mdx new file mode 100644 index 000000000..6c4203891 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-login-with-otp.mdx @@ -0,0 +1,48 @@ +--- +title: "loginWithOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Logs in a user using an OTP verification token. + +
    +
  • This function logs in a user using the verification token received after OTP verification (from email or SMS).
  • +
  • If a public key is not provided, a new API key pair will be generated for authentication.
  • +
  • Optionally invalidates any existing sessions for the user if ``invalidateExisting`` is set to true.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Handles cleanup of unused key pairs if login fails.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1212

+ + + + + + +flag to invalidate existing session for the user. + + +public key to use for authentication. If not provided, a new key pair will be generated. + + +session key to use for session creation (defaults to the default session key). + + +verification token received after OTP verification. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token. + diff --git a/generated-docs/formatted/core/turnkey-client-login-with-passkey.mdx b/generated-docs/formatted/core/turnkey-client-login-with-passkey.mdx new file mode 100644 index 000000000..4ff050970 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-login-with-passkey.mdx @@ -0,0 +1,45 @@ +--- +title: "loginWithPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Logs in a user using a passkey, optionally specifying the public key, session key, and session expiration. + +
    +
  • This function initiates the login process with a passkey and handles session creation and storage.
  • +
  • If a public key is not provided, a new key pair will be generated for authentication.
  • +
  • If a session key is not provided, the default session key will be used.
  • +
  • The session expiration can be customized via the expirationSeconds parameter.
  • +
  • Handles cleanup of unused key pairs if login fails.
  • +
+ +

Package: core

+ +

Defined in: core.ts:304

+ + + + + + +session expiration time in seconds (defaults to the configured default). + + +public key to use for authentication. If not provided, a new key pair will be generated. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token. + diff --git a/generated-docs/formatted/core/turnkey-client-login-with-wallet.mdx b/generated-docs/formatted/core/turnkey-client-login-with-wallet.mdx new file mode 100644 index 000000000..36669bd16 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-login-with-wallet.mdx @@ -0,0 +1,48 @@ +--- +title: "loginWithWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Logs in a user using the specified wallet provider. + +
    +
  • This function logs in a user by authenticating with the provided wallet provider via a wallet-based signature.
  • +
  • If a public key is not provided, a new one will be generated for authentication.
  • +
  • Optionally accepts a custom session key and session expiration time.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Throws an error if a public key cannot be found or generated, or if the login process fails.
  • +
+ +

Package: core

+ +

Defined in: core.ts:665

+ + + + + + +optional session expiration time in seconds (defaults to the configured default). + + +optional public key to associate with the session (generated if not provided). + + +optional key to store the session under (defaults to the default session key). + + +wallet provider to use for authentication. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the created session token. + diff --git a/generated-docs/formatted/core/turnkey-client-logout.mdx b/generated-docs/formatted/core/turnkey-client-logout.mdx new file mode 100644 index 000000000..4698f5261 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-logout.mdx @@ -0,0 +1,37 @@ +--- +title: "logout()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Logs out the current client session. + +
    +
  • This function clears the specified session and removes any associated key pairs from storage.
  • +
  • If a sessionKey is provided, it logs out from that session; otherwise, it logs out from the active session.
  • +
  • Cleans up any api keys associated with the session.
  • +
+ +

Package: core

+ +

Defined in: core.ts:259

+ + + + + + +session key to specify which session to log out from (defaults to the active session). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the logout process is complete. + diff --git a/generated-docs/formatted/core/turnkey-client-refresh-session.mdx b/generated-docs/formatted/core/turnkey-client-refresh-session.mdx new file mode 100644 index 000000000..dbfd330ff --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-refresh-session.mdx @@ -0,0 +1,52 @@ +--- +title: "refreshSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Refreshes the session associated with the specified session key, or the active session by default. + +
    +
  • This function refreshes the session and updates the session token and key pair associated with the given session key.
  • +
  • If a sessionKey is provided, it will refresh the session under that key; otherwise, it will use the current active session key.
  • +
  • Optionally allows specifying a new expiration time for the session, a custom public key, and whether to invalidate the existing session after refreshing.
  • +
  • Makes a request to the Turnkey API to stamp a new login and stores the refreshed session token.
  • +
  • Automatically manages key pair cleanup and session storage to ensure consistency.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:3485

+ + + + + + +expiration time in seconds for the refreshed session (defaults to the configured default). + + +flag to invalidate the existing session before refreshing (defaults to false). + + +public key to use for the refreshed session (if not provided, a new key pair will be generated). + + +session key to refresh the session under (defaults to the active session key). + + +parameter to stamp the request with a specific stamper. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `TStampLoginResponse` object containing the refreshed session details. + diff --git a/generated-docs/formatted/core/turnkey-client-remove-oauth-providers.mdx b/generated-docs/formatted/core/turnkey-client-remove-oauth-providers.mdx new file mode 100644 index 000000000..07c6e22d9 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-remove-oauth-providers.mdx @@ -0,0 +1,45 @@ +--- +title: "removeOauthProviders()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Removes a list of OAuth providers from the user. + +
    +
  • This function removes OAuth providers (e.g., Google, Apple) from the user's account.
  • +
  • If a userId is provided, it removes the providers for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Returns an array of remaining provider IDs associated with the user after removal.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2687

+ + + + + + +IDs of the OAuth providers to remove. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove the provider for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of provider IDs that were removed. + diff --git a/generated-docs/formatted/core/turnkey-client-remove-passkeys.mdx b/generated-docs/formatted/core/turnkey-client-remove-passkeys.mdx new file mode 100644 index 000000000..179721a19 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-remove-passkeys.mdx @@ -0,0 +1,45 @@ +--- +title: "removePasskeys()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Removes passkeys (authenticator) from the user. + +
    +
  • This function removes passkeys (WebAuthn/FIDO2 authenticators) from the user's account.
  • +
  • If a userId is provided, it removes the passkeys for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Returns an array of remaining authenticator IDs for the user after removal.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2814

+ + + + + + +IDs of the authenticators (passkeys) to remove. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove the passkeys for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of authenticator IDs that were removed. + diff --git a/generated-docs/formatted/core/turnkey-client-remove-user-email.mdx b/generated-docs/formatted/core/turnkey-client-remove-user-email.mdx new file mode 100644 index 000000000..7dc3f9091 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-remove-user-email.mdx @@ -0,0 +1,41 @@ +--- +title: "removeUserEmail()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Removes the user's email address. + +
    +
  • This function removes the user's email address by setting it to an empty string.
  • +
  • If a userId is provided, it removes the email for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:2362

+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove a specific user's email address (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user whose email was removed. + diff --git a/generated-docs/formatted/core/turnkey-client-remove-user-phone-number.mdx b/generated-docs/formatted/core/turnkey-client-remove-user-phone-number.mdx new file mode 100644 index 000000000..eb3bd8d17 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-remove-user-phone-number.mdx @@ -0,0 +1,41 @@ +--- +title: "removeUserPhoneNumber()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Removes the user's phone number. + +
    +
  • This function removes the user's phone number by setting it to an empty string.
  • +
  • If a userId is provided, it removes the phone number for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:2471

+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove a specific user's phone number (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user whose phone number was removed. + diff --git a/generated-docs/formatted/core/turnkey-client-set-active-session.mdx b/generated-docs/formatted/core/turnkey-client-set-active-session.mdx new file mode 100644 index 000000000..f1e6e3a5b --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-set-active-session.mdx @@ -0,0 +1,38 @@ +--- +title: "setActiveSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Sets the active session to the specified session key. + +
    +
  • This function updates the ``activeSessionKey`` in persistent storage to the specified session key.
  • +
  • Ensures that subsequent operations use the session associated with this key as the active session.
  • +
  • Does not validate whether the session key exists or is valid; it simply updates the pointer.
  • +
  • Useful for switching between multiple stored sessions or restoring a previous session context.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3633

+ + + + + + +session key to set as the active session. + + + + + +A successful response returns the following fields: + + + A promise that resolves when the active session key is successfully set. + diff --git a/generated-docs/formatted/core/turnkey-client-sign-and-send-transaction.mdx b/generated-docs/formatted/core/turnkey-client-sign-and-send-transaction.mdx new file mode 100644 index 000000000..41483db8c --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-sign-and-send-transaction.mdx @@ -0,0 +1,56 @@ +--- +title: "signAndSendTransaction()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Signs and broadcasts a transaction using the specified wallet account. + +
    +
  • For **connected wallets**:
  • +
  • Calls the wallet’s native ``signAndSendTransaction`` method.
  • +
  • Does **not** require an ``rpcUrl``.
  • +
+ +
    +
  • For **embedded wallets**:
  • +
  • Signs the transaction using the Turnkey API.
  • +
  • Requires an ``rpcUrl`` to broadcast the transaction.
  • +
  • Broadcasts the transaction using a JSON-RPC client.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2125

+ + + + + + +required for embedded wallets to broadcast the signed transaction. + + +optional stamper to tag the signing request. + + +transaction type (e.g., "TRANSACTION_TYPE_SOLANA"). + + +unsigned transaction (serialized string). + + +wallet account to use for signing and sending. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a transaction signature or hash. + diff --git a/generated-docs/formatted/core/turnkey-client-sign-message.mdx b/generated-docs/formatted/core/turnkey-client-sign-message.mdx new file mode 100644 index 000000000..c21d7f3e7 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-sign-message.mdx @@ -0,0 +1,66 @@ +--- +title: "signMessage()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Signs a message using the specified wallet account. + +
    +
  • Supports both embedded and connected wallets.
  • +
  • For **connected wallets**:
  • +
  • Delegates signing to the wallet provider’s native signing method.
  • +
  • **Important:** For Ethereum wallets (e.g., MetaMask), signatures follow [EIP-191](https://eips.ethereum.org/EIPS/eip-191).
  • +
+ +The message is automatically prefixed with ``"\x19Ethereum Signed Message:\n" + message length`` before signing. As a result, this signature **cannot be used as a raw transaction signature** or broadcast on-chain. + +
    +
  • For **embedded wallets**, uses the Turnkey API to sign the message directly.
  • +
  • Automatically handles message encoding and hashing based on the wallet account’s address format,
  • +
+ +unless explicitly overridden. + +

Package: core

+ +

Defined in: core.ts:1954

+ + + + + + +whether to prefix the message with Ethereum's `"\x19Ethereum Signed Message:\n"` string. + - If `true` (default for Ethereum), the message is prefixed before signing. + - If `false`: + - Connected wallets will throw an error because they always prefix automatically. + - Embedded wallets will sign the raw message without any prefix. + + +override for the payload encoding (defaults to the encoding appropriate for the address type). + + +override for the hash function (defaults to the hash function appropriate for the address type). + + +message to sign. + + +stamper to tag the signing request (e.g., Passkey, ApiKey, or Wallet). + + +wallet account to use for signing. + + + + + +A successful response returns the following fields: + + + A promise resolving to a `v1SignRawPayloadResult` containing the signature and metadata. + diff --git a/generated-docs/formatted/core/turnkey-client-sign-transaction.mdx b/generated-docs/formatted/core/turnkey-client-sign-transaction.mdx new file mode 100644 index 000000000..7ff625251 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-sign-transaction.mdx @@ -0,0 +1,48 @@ +--- +title: "signTransaction()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Signs a transaction using the specified wallet account. + +
    +
  • This function signs a blockchain transaction using the provided wallet address and transaction data.
  • +
  • Supports all Turnkey-supported blockchain networks (e.g., Ethereum, Solana, Tron).
  • +
  • Automatically determines the appropriate signing method based on the transaction type.
  • +
  • Delegates signing to the Turnkey API, which returns the signed transaction and related metadata.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ +

Package: core

+ +

Defined in: core.ts:2052

+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +type of transaction (e.g., "TRANSACTION_TYPE_ETHEREUM", "TRANSACTION_TYPE_SOLANA", "TRANSACTION_TYPE_TRON"). + + +unsigned transaction data (serialized as a string) to be signed. + + +wallet account to use for signing the transaction. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `TSignTransactionResponse` object containing the signed transaction and any additional signing metadata. + diff --git a/generated-docs/formatted/core/turnkey-client-sign-up-with-oauth.mdx b/generated-docs/formatted/core/turnkey-client-sign-up-with-oauth.mdx new file mode 100644 index 000000000..fdbc07fd3 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-sign-up-with-oauth.mdx @@ -0,0 +1,50 @@ +--- +title: "signUpWithOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Signs up a user using OAuth authentication. + +
    +
  • This function creates a new sub-organization for the user using the provided OIDC token, public key, and provider name.
  • +
  • Handles the full OAuth sign-up flow, including sub-organization creation and session management.
  • +
  • Optionally accepts additional sub-organization creation parameters and a custom session key.
  • +
  • After successful sign-up, automatically logs in the user and returns a signed JWT session token.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1614

+ + + + + + +parameters for sub-organization creation (e.g., authenticators, user metadata). + + +OIDC token received after successful authentication with the OAuth provider. + + +name of the OAuth provider (e.g., "Google", "Apple"). + + +public key to associate with the new sub-organization. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/core/turnkey-client-sign-up-with-otp.mdx b/generated-docs/formatted/core/turnkey-client-sign-up-with-otp.mdx new file mode 100644 index 000000000..e95630199 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-sign-up-with-otp.mdx @@ -0,0 +1,54 @@ +--- +title: "signUpWithOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Signs up a user using an OTP verification token. + +
    +
  • This function signs up a user using the verification token received after OTP verification (from email or SMS).
  • +
  • Creates a new sub-organization for the user with the provided parameters and associates the contact (email or phone) with the sub-organization.
  • +
  • Automatically generates a new API key pair for authentication and session management.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Handles both email and SMS OTP types, and supports additional sub-organization creation parameters.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1294

+ + + + + + +contact information for the user (e.g., email address or phone number). + + +parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +flag to invalidate existing session for the user. + + +type of OTP being used (OtpType.Email or OtpType.Sms). + + +session key to use for session creation (defaults to the default session key). + + +verification token received after OTP verification. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/core/turnkey-client-sign-up-with-passkey.mdx b/generated-docs/formatted/core/turnkey-client-sign-up-with-passkey.mdx new file mode 100644 index 000000000..286cc00a1 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-sign-up-with-passkey.mdx @@ -0,0 +1,48 @@ +--- +title: "signUpWithPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Signs up a user using a passkey, creating a new sub-organization and session. + +
    +
  • This function creates a new passkey authenticator and uses it to register a new sub-organization for the user.
  • +
  • Handles both passkey creation and sub-organization creation in a single flow.
  • +
  • Optionally accepts additional sub-organization parameters, a custom session key, a custom passkey display name, and a custom session expiration.
  • +
  • Automatically generates a new API key pair for authentication and session management.
  • +
  • Stores the resulting session token and manages cleanup of unused key pairs.
  • +
+ +

Package: core

+ +

Defined in: core.ts:387

+ + + + + + +parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +session expiration time in seconds (defaults to the configured default). + + +display name for the passkey (defaults to a generated name based on the current timestamp). + + +session key to use for storing the session (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/core/turnkey-client-sign-up-with-wallet.mdx b/generated-docs/formatted/core/turnkey-client-sign-up-with-wallet.mdx new file mode 100644 index 000000000..09f310e23 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-sign-up-with-wallet.mdx @@ -0,0 +1,48 @@ +--- +title: "signUpWithWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Signs up a user using a wallet, creating a new sub-organization and session. + +
    +
  • This function creates a new wallet authenticator and uses it to register a new sub-organization for the user.
  • +
  • Handles both wallet authentication and sub-organization creation in a single flow.
  • +
  • Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration.
  • +
  • Automatically generates additional API key pairs for authentication and session management.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided, and manages cleanup of unused key pairs.
  • +
+ +

Package: core

+ +

Defined in: core.ts:755

+ + + + + + +parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +session expiration time in seconds (defaults to the configured default). + + +session key to use for storing the session (defaults to the default session key). + + +wallet provider to use for authentication. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/core/turnkey-client-store-session.mdx b/generated-docs/formatted/core/turnkey-client-store-session.mdx new file mode 100644 index 000000000..f47f23317 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-store-session.mdx @@ -0,0 +1,42 @@ +--- +title: "storeSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Stores a session token and updates the session associated with the specified session key, or by default the active session. + +
    +
  • This function parses and stores a signed JWT session token in local storage, associating it with the given session key.
  • +
  • If a sessionKey is provided, the session will be stored under that key; otherwise, it will use the default session key.
  • +
  • If a session already exists for the session key, its associated key pair will be deleted before storing the new session.
  • +
  • After storing the session, any unused key pairs are automatically cleared from storage.
  • +
  • Ensures that session management is consistent and prevents orphaned key pairs.
  • +
+ +

Package: core

+ +

Defined in: core.ts:3380

+ + + + + + +session key to store the session under (defaults to the default session key). + + +JWT session token to store. + + + + + +A successful response returns the following fields: + + + A promise that resolves when the session is successfully stored. + diff --git a/generated-docs/formatted/core/turnkey-client-switch-wallet-account-chain.mdx b/generated-docs/formatted/core/turnkey-client-switch-wallet-account-chain.mdx new file mode 100644 index 000000000..abdea8acb --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-switch-wallet-account-chain.mdx @@ -0,0 +1,44 @@ +--- +title: "switchWalletAccountChain()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Switches the wallet provider associated with a given wallet account to a different chain. + +
    +
  • Requires the wallet manager and its connector to be initialized
  • +
  • Only works for connected wallet accounts
  • +
  • Looks up the provider for the given account address
  • +
  • Does nothing if the provider is already on the desired chain.
  • +
+ +

Package: core

+ +

Defined in: core.ts:596

+ + + + + + +The target chain, specified as a chain ID string or a SwitchableChain object. + + +The wallet account whose provider should be switched. + + +Optional list of wallet providers to search; falls back to `getWalletProviders()` if omitted. + + + + + +A successful response returns the following fields: + + + A promise that resolves once the chain switch is complete. + diff --git a/generated-docs/formatted/core/turnkey-client-switch-wallet-provider-chain.mdx b/generated-docs/formatted/core/turnkey-client-switch-wallet-provider-chain.mdx new file mode 100644 index 000000000..a2c450999 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-switch-wallet-provider-chain.mdx @@ -0,0 +1,37 @@ +--- +title: "switchWalletProviderChain()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Switches the specified wallet provider to a different blockchain chain. + +
    +
  • Requires the wallet manager and its connector to be initialized.
  • +
  • The wallet provider must have at least one connected address.
  • +
  • Does nothing if the wallet provider is already on the desired chain.
  • +
+ +

Package: core

+ +

Defined in: core.ts:589

+ + + + + wallet provider to switch. + + + + target chain as a chain ID string or SwitchableChain object. + + + +A successful response returns the following fields: + + + A promise that resolves once the chain switch is complete. + diff --git a/generated-docs/formatted/core/turnkey-client-update-user-email.mdx b/generated-docs/formatted/core/turnkey-client-update-user-email.mdx new file mode 100644 index 000000000..178cb6743 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-update-user-email.mdx @@ -0,0 +1,48 @@ +--- +title: "updateUserEmail()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Updates the user's email address. + +
    +
  • This function updates the user's email address and, if provided, verifies it using a verification token (typically from an OTP flow).
  • +
  • If a userId is provided, it updates the email for that specific user; otherwise, it uses the current session's userId.
  • +
  • If a verificationToken is not provided, the email will be updated but will not be marked as verified.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Handles session management and error reporting for both update and verification flows.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2293

+ + + + + + +new email address to set for the user. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to update a specific user's email (defaults to the current session's userId). + + +verification token from OTP email verification (required if verifying the email). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the updated user. + diff --git a/generated-docs/formatted/core/turnkey-client-update-user-name.mdx b/generated-docs/formatted/core/turnkey-client-update-user-name.mdx new file mode 100644 index 000000000..b0a2b27f9 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-update-user-name.mdx @@ -0,0 +1,45 @@ +--- +title: "updateUserName()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Updates the user's name. + +
    +
  • This function updates the user's display name.
  • +
  • If a userId is provided, it updates the name for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Handles session management and error reporting for the update flow.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2524

+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to update a specific user's name (defaults to the current session's userId). + + +new name to set for the user. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the updated user. + diff --git a/generated-docs/formatted/core/turnkey-client-update-user-phone-number.mdx b/generated-docs/formatted/core/turnkey-client-update-user-phone-number.mdx new file mode 100644 index 000000000..992db5826 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-update-user-phone-number.mdx @@ -0,0 +1,48 @@ +--- +title: "updateUserPhoneNumber()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Updates the user's phone number. + +
    +
  • This function updates the user's phone number and, if provided, verifies it using a verification token (from an OTP flow).
  • +
  • If a userId is provided, it updates the phone number for that specific user; otherwise, it uses the current session's userId.
  • +
  • If a verificationToken is not provided, the phone number will be updated but will not be marked as verified.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Handles session management and error reporting for both update and verification flows.
  • +
+ +

Package: core

+ +

Defined in: core.ts:2415

+ + + + + + +new phone number to set for the user. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to update a specific user's phone number (defaults to the current session's userId). + + +verification token from OTP phone verification (required if verifying the phone number). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the updated user. + diff --git a/generated-docs/formatted/core/turnkey-client-verify-otp.mdx b/generated-docs/formatted/core/turnkey-client-verify-otp.mdx new file mode 100644 index 000000000..cebbafab1 --- /dev/null +++ b/generated-docs/formatted/core/turnkey-client-verify-otp.mdx @@ -0,0 +1,53 @@ +--- +title: "verifyOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + + + +Verifies the OTP code sent to the user. + +
    +
  • This function verifies the OTP code entered by the user against the OTP sent to their contact information (email or phone) using the auth proxy.
  • +
  • If verification is successful, it returns the sub-organization ID associated with the contact (if it exists) and a verification token.
  • +
  • The verification token can be used for subsequent login or sign-up flows.
  • +
  • Handles both email and SMS OTP types.
  • +
+ +

Package: core

+ +

Defined in: core.ts:1144

+ + + + + + +contact information for the user (e.g., email address or phone number). + + +OTP code entered by the user. + + +ID of the OTP to verify (returned from `initOtp`). + + +type of OTP being verified (OtpType.Email or OtpType.Sms). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an object containing: + - subOrganizationId: sub-organization ID if the contact is already associated with a sub-organization, or an empty string if not. + - verificationToken: verification token to be used for login or sign-up. + + + + + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-add-oauth-provider.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-add-oauth-provider.mdx new file mode 100644 index 000000000..94fd0e43e --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-add-oauth-provider.mdx @@ -0,0 +1,47 @@ +--- +title: "addOauthProvider()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Adds an OAuth provider to the user. + +
    +
  • This function adds an OAuth provider (e.g., Google, Apple) to the user account.
  • +
  • If a userId is provided, it adds the provider for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically checks if an account already exists for the provided OIDC token and prevents duplicate associations.
  • +
  • If the user's email is not set or not verified, attempts to update and verify the email using the email from the OIDC token.
  • +
  • Handles session management and error reporting for the add provider flow.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +OIDC token for the OAuth provider. + + +name of the OAuth provider to add (e.g., "Google", "Apple"). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to add the provider for a specific user (defaults to current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of provider IDs associated with the user. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-add-passkey.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-add-passkey.mdx new file mode 100644 index 000000000..246e43320 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-add-passkey.mdx @@ -0,0 +1,46 @@ +--- +title: "addPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Adds a new passkey authenticator for the user. + +
    +
  • This function prompts the user to create a new passkey (WebAuthn/FIDO2) and adds it as an authenticator for the user.
  • +
  • Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow.
  • +
  • If a userId is provided, the passkey is added for that specific user; otherwise, it uses the current session's userId.
  • +
  • The passkey's name and display name can be customized; if not provided, defaults are generated.
  • +
  • The resulting passkey attestation and challenge are registered with Turnkey as a new authenticator.
  • +
+ + + + + + +display name of the passkey (defaults to the value of `name`). + + +name of the passkey (defaults to "Turnkey Passkey-`timestamp`"). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to add the passkey for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of authenticator IDs for the newly added passkey(s). + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-clear-all-sessions.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-clear-all-sessions.mdx new file mode 100644 index 000000000..af10a8234 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-clear-all-sessions.mdx @@ -0,0 +1,30 @@ +--- +title: "clearAllSessions()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Clears all sessions and resets the active session state. + +
    +
  • This function removes all session data from the client and persistent storage, including all associated key pairs.
  • +
  • Iterates through all stored session keys, clearing each session and deleting its corresponding API key pair.
  • +
  • After clearing, there will be no active session, and all session-related data will be removed from local storage.
  • +
  • Throws an error if no sessions exist or if there is an error during the clearing process.
  • +
+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves when all sessions are successfully cleared. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-clear-session.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-clear-session.mdx new file mode 100644 index 000000000..010b2d1ee --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-clear-session.mdx @@ -0,0 +1,36 @@ +--- +title: "clearSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Clears the session associated with the specified session key, or the active session by default. + +
    +
  • This function deletes the session and its associated key pair from storage.
  • +
  • If a sessionKey is provided, it will clear the session under that key; otherwise, it will clear the default (active) session.
  • +
  • Removes the session data from local storage and deletes the corresponding API key pair from the key store.
  • +
  • Throws an error if the session does not exist or if there is an error during the clearing process.
  • +
+ + + + + + +session key to clear the session under (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the session is successfully cleared. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-clear-unused-key-pairs.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-clear-unused-key-pairs.mdx new file mode 100644 index 000000000..9fbbc560d --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-clear-unused-key-pairs.mdx @@ -0,0 +1,30 @@ +--- +title: "clearUnusedKeyPairs()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Clears any unused API key pairs from persistent storage. + +
    +
  • This function scans all API key pairs stored in indexedDB and removes any key pairs that are not associated with a session in persistent storage.
  • +
  • Ensures that only key pairs referenced by existing sessions are retained, preventing orphaned or stale key pairs from accumulating.
  • +
  • Iterates through all stored session keys and builds a map of in-use public keys, then deletes any key pairs not present in this map.
  • +
  • Intended to be called after session changes (e.g., login, logout, session replacement) to keep key storage clean and secure.
  • +
+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves when all unused key pairs are successfully cleared. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-complete-oauth.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-complete-oauth.mdx new file mode 100644 index 000000000..eb78b2b4a --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-complete-oauth.mdx @@ -0,0 +1,52 @@ +--- +title: "completeOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Completes the OAuth authentication flow by either signing up or logging in the user, depending on whether a sub-organization already exists for the provided OIDC token. + +
    +
  • This function first checks if there is an existing sub-organization associated with the OIDC token.
  • +
  • If a sub-organization exists, it proceeds with the OAuth login flow.
  • +
  • If no sub-organization exists, it creates a new sub-organization and completes the sign-up flow.
  • +
  • Optionally accepts a custom OAuth provider name, session key, and additional sub-organization creation parameters.
  • +
  • Handles session storage and management, and supports invalidating existing sessions if specified.
  • +
+ + + + + + +parameters for sub-organization creation (e.g., authenticators, user metadata). + + +flag to invalidate existing sessions for the user. + + +OIDC token received after successful authentication with the OAuth provider. + + +name of the OAuth provider (defaults to a generated name with a timestamp). + + +public key to use for authentication. Must be generated prior to calling this function. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the user. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-complete-otp.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-complete-otp.mdx new file mode 100644 index 000000000..2f4845938 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-complete-otp.mdx @@ -0,0 +1,58 @@ +--- +title: "completeOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Completes the OTP authentication flow by verifying the OTP code and then either signing up or logging in the user. + +
    +
  • This function first verifies the OTP code for the provided contact and OTP type.
  • +
  • If the contact is not associated with an existing sub-organization, it will automatically create a new sub-organization and complete the sign-up flow.
  • +
  • If the contact is already associated with a sub-organization, it will complete the login flow.
  • +
  • Supports passing a custom public key for authentication, invalidating existing session, specifying a session key, and providing additional sub-organization creation parameters.
  • +
  • Handles both email and SMS OTP types.
  • +
+ + + + + + +contact information for the user (e.g., email address or phone number). + + +parameters for sub-organization creation (e.g., authenticators, user metadata). + + +flag to invalidate existing sessions for the user. + + +OTP code entered by the user. + + +ID of the OTP to complete (returned from `initOtp`). + + +type of OTP being completed (OtpType.Email or OtpType.Sms). + + +public key to use for authentication. If not provided, a new key pair may be generated. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the user. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-connect-wallet-account.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-connect-wallet-account.mdx new file mode 100644 index 000000000..b5a1361f0 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-connect-wallet-account.mdx @@ -0,0 +1,29 @@ +--- +title: "connectWalletAccount()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Connects the specified wallet account. + +
    +
  • Requires the wallet manager and its connector to be initialized.
  • +
+ + + + + wallet provider to connect. + + + +A successful response returns the following fields: + + + A promise that resolves once the wallet account is connected. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-create-api-key-pair.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-create-api-key-pair.mdx new file mode 100644 index 000000000..0644b6db5 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-create-api-key-pair.mdx @@ -0,0 +1,40 @@ +--- +title: "createApiKeyPair()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Creates a new API key pair and returns the public key. + +
    +
  • This function generates a new API key pair and stores it in the underlying key store (IndexedDB).
  • +
  • If an external key pair is provided, it will use that key pair for creation instead of generating a new one.
  • +
  • If ``storeOverride`` is set to true, the generated or provided public key will be set as the override key in the API key stamper, making it the active key for subsequent signing operations.
  • +
  • Ensures the API key stamper is initialized before proceeding.
  • +
  • Handles both native CryptoKeyPair objects and raw key material.
  • +
+ + + + + + +An externally generated key pair (either a CryptoKeyPair or an object with publicKey/privateKey strings) to use instead of generating a new one. + + +If true, sets the generated or provided public key as the override key in the API key stamper (defaults to false). +@returnparams.s A promise that resolves to the public key of the created or provided API key pair as a string. + + + + + +A successful response returns the following fields: + + + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-create-passkey.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-create-passkey.mdx new file mode 100644 index 000000000..9f73f99d5 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-create-passkey.mdx @@ -0,0 +1,47 @@ +--- +title: "createPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Creates a new passkey authenticator for the user. + +
    +
  • This function generates a new passkey attestation and challenge, suitable for registration with the user's device.
  • +
  • Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow.
  • +
  • The resulting attestation and challenge can be used to register the passkey with Turnkey.
  • +
+ + + + + + +display name for the passkey. If not provided, defaults to "A Passkey". + + +name of the passkey. If not provided, defaults to "A Passkey". + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an object containing: + - attestation: attestation object returned from the passkey creation process. + - encodedChallenge: encoded challenge string used for passkey registration. + + + + + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet-accounts.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet-accounts.mdx new file mode 100644 index 000000000..6615a8e8e --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet-accounts.mdx @@ -0,0 +1,47 @@ +--- +title: "createWalletAccounts()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Creates new accounts in the specified wallet. + +
    +
  • This function creates new wallet accounts based on the provided account parameters or address formats.
  • +
  • If a walletId is provided, it creates the accounts in that specific wallet; otherwise, it uses the current session's wallet.
  • +
  • If a list of address formats is provided, it will create accounts in the wallet based on those formats, automatically determining the next available path indexes to avoid duplicates with existing accounts.
  • +
  • If account parameters are provided, they are used directly for account creation.
  • +
  • Automatically queries existing wallet accounts to prevent duplicate account creation for the same address format and path.
  • +
  • Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +An array of account parameters or address formats to create in the wallet. + + +organization ID to create the accounts under a specific organization (walletId must be associated with the sub-organization). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +ID of the wallet to create accounts in. + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of addresses for the newly created accounts. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet.mdx new file mode 100644 index 000000000..fe9d7d0db --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet.mdx @@ -0,0 +1,51 @@ +--- +title: "createWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Creates a new wallet for sub-organization. + +
    +
  • This function creates a new wallet for the current sub-organization.
  • +
  • If an organizationId is provided, the wallet will be created under that specific sub-organization; otherwise, it uses the current session's organizationId.
  • +
  • If a list of address formats is provided, accounts will be created in the wallet based on those formats (starting from path index 0).
  • +
  • If a list of account parameters is provided, those accounts will be created in the wallet.
  • +
  • If no accounts or address formats are provided, default Ethereum and Solana accounts will be created.
  • +
  • Optionally allows specifying the mnemonic length for the wallet seed phrase (defaults to 12).
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +array of account parameters or address formats to create in the wallet. + + +mnemonic length for the wallet seed phrase (defaults to 12). + + +organization ID to create the wallet under a specific sub-organization (defaults to the current session's organizationId). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +name of the wallet to create. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the ID of the newly created wallet. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-delete-sub-organization.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-delete-sub-organization.mdx new file mode 100644 index 000000000..464813615 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-delete-sub-organization.mdx @@ -0,0 +1,40 @@ +--- +title: "deleteSubOrganization()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Deletes the current sub-organization (sub-org) for the active session. + +
    +
  • This function deletes the sub-organization associated with the current active session.
  • +
  • By default, the deletion will fail if any wallets associated with the sub-organization have not been exported.
  • +
  • If ``deleteWithoutExport`` is set to true, the sub-organization will be deleted even if its wallets have not been exported (potentially resulting in loss of access to those wallets).
  • +
  • Requires an active session; otherwise, an error is thrown.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +flag to delete the sub-organization without requiring all wallets to be exported first (defaults to false). + + +parameter to stamp the request with a specific stamper. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `TDeleteSubOrganizationResponse` object containing the result of the deletion. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-disconnect-wallet-account.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-disconnect-wallet-account.mdx new file mode 100644 index 000000000..e24f08ccf --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-disconnect-wallet-account.mdx @@ -0,0 +1,29 @@ +--- +title: "disconnectWalletAccount()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Disconnects the specified wallet account. + +
    +
  • Requires the wallet manager and its connector to be initialized.
  • +
+ + + + + wallet provider to disconnect. + + + +A successful response returns the following fields: + + + A promise that resolves once the wallet account is disconnected. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-export-private-key.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-export-private-key.mdx new file mode 100644 index 000000000..71ace17ae --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-export-private-key.mdx @@ -0,0 +1,46 @@ +--- +title: "exportPrivateKey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Exports a private key as an encrypted bundle. + +
    +
  • This function exports the specified private key as an encrypted bundle, suitable for backup or transfer.
  • +
  • The exported bundle contains the private key's key material, encrypted to the provided target public key.
  • +
  • If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown.
  • +
  • If an organizationId is provided, the private key will be exported under that sub-organization; otherwise, the current session's organizationId is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +organization ID to export the private key under a specific sub + + +ID of the private key to export. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +public key to encrypt the bundle to (required). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an `ExportBundle` object containing the encrypted private key and metadata. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet-account.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet-account.mdx new file mode 100644 index 000000000..3a2c492c0 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet-account.mdx @@ -0,0 +1,46 @@ +--- +title: "exportWalletAccount()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Exports a wallet account as an encrypted bundle. + +
    +
  • This function exports the specified wallet account as an encrypted bundle, suitable for backup or transfer.
  • +
  • The exported bundle contains the wallet account's key material, encrypted to the provided target public key.
  • +
  • If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown.
  • +
  • If an organizationId is provided, the wallet account will be exported under that sub-organization; otherwise, the current session's organizationId is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +address of the wallet account to export. + + +organization ID to export the wallet account under a specific sub-organization. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +public key to encrypt the bundle to. + + + + + +A successful response returns the following fields: + + + A promise that resolves to an `ExportBundle` object containing the encrypted wallet account and metadata. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet.mdx new file mode 100644 index 000000000..e41ec7672 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet.mdx @@ -0,0 +1,47 @@ +--- +title: "exportWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Exports a wallet as an encrypted bundle. + +
    +
  • This function exports the specified wallet and its accounts as an encrypted bundle, suitable for backup or transfer.
  • +
  • The exported bundle contains the wallet's seed phrase, encrypted to the provided target public key.
  • +
  • If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown.
  • +
  • If an organizationId is provided, the wallet will be exported under that sub-organization; otherwise, the current session's organizationId is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • The exported bundle can later be imported using the ``importWallet`` method.
  • +
+ + + + + + +organization ID to export the wallet under a specific sub-organization (walletId must be associated with the sub-organization). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +public key to encrypt the bundle to (required). + + +ID of the wallet to export. + + + + + +A successful response returns the following fields: + + + A promise that resolves to an `ExportBundle` object containing the encrypted wallet seed phrase and metadata. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-user.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-user.mdx new file mode 100644 index 000000000..93fd8d43b --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-user.mdx @@ -0,0 +1,43 @@ +--- +title: "fetchUser()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Fetches the user details for the current session or a specified user. + +
    +
  • Retrieves user details from the Turnkey API using the provided userId and organizationId, or defaults to those from the active session.
  • +
  • If no userId is provided, the userId from the current session is used.
  • +
  • If no organizationId is provided, the organizationId from the current session is used.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Ensures that an active session exists before making the request.
  • +
+ + + + + + +organization ID to specify the sub-organization (defaults to the current session's organizationId). + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to fetch specific user details (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `v1User` object containing the user details. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallet-accounts.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallet-accounts.mdx new file mode 100644 index 000000000..e6c574b06 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallet-accounts.mdx @@ -0,0 +1,46 @@ +--- +title: "fetchWalletAccounts()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Fetches all accounts for a specific wallet, including both embedded and connected wallet accounts. + +
    +
  • For embedded wallets, retrieves accounts from the Turnkey API, supporting pagination (defaults to the first page with a limit of 100 accounts).
  • +
  • For connected wallets (e.g., browser extensions or external providers), constructs account objects for each connected address from the provided or discovered wallet providers.
  • +
  • Automatically determines the account type and populates relevant fields such as address, curve, and signing capability.
  • +
  • Optionally allows filtering by a specific set of wallet providers and supports custom pagination options.
  • +
  • Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +pagination options for embedded wallets. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +wallet for which to fetch accounts. + + +list of wallet providers to filter by (used for connected wallets). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of `v1WalletAccount` objects. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallets.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallets.mdx new file mode 100644 index 000000000..be96b4125 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallets.mdx @@ -0,0 +1,38 @@ +--- +title: "fetchWallets()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Fetches all wallets for the current user, including both embedded and connected wallets. + +
    +
  • Retrieves all wallets associated with the organizationId from the current active session.
  • +
  • For each embedded wallet, automatically fetches and attaches all associated wallet accounts.
  • +
  • For connected wallets (e.g., browser extensions or external providers), groups providers by wallet name and attaches all connected accounts.
  • +
  • Returns both embedded and connected wallets in a single array, each with their respective accounts populated.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of `Wallet` objects. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-get-active-session-key.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-get-active-session-key.mdx new file mode 100644 index 000000000..1a985ae12 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-get-active-session-key.mdx @@ -0,0 +1,30 @@ +--- +title: "getActiveSessionKey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Retrieves the active session key currently set in persistent storage. + +
    +
  • This function fetches the session key that is currently marked as active in the client's persistent storage.
  • +
  • The active session key determines which session is used for all session-dependent operations.
  • +
  • If no active session key is set, returns ``undefined``.
  • +
  • Useful for determining which session is currently in use, especially when managing multiple sessions.
  • +
+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves to the active session key as a string, or `undefined` if no active session is set. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-get-all-sessions.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-get-all-sessions.mdx new file mode 100644 index 000000000..88c2d2832 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-get-all-sessions.mdx @@ -0,0 +1,30 @@ +--- +title: "getAllSessions()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Retrieves all sessions stored in persistent storage. + +
    +
  • This function fetches all session objects currently stored by the client, including those that are not active.
  • +
  • Returns a record mapping each session key to its corresponding ``Session`` object.
  • +
  • Useful for session management, auditing, or displaying all available sessions to the user.
  • +
  • Automatically skips any session keys that do not have a valid session object.
  • +
+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves to a record of session keys and their corresponding `Session` objects, or `undefined` if no sessions exist. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-get-proxy-auth-config.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-get-proxy-auth-config.mdx new file mode 100644 index 000000000..13032c47c --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-get-proxy-auth-config.mdx @@ -0,0 +1,34 @@ +--- +title: "getProxyAuthConfig()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Fetches the WalletKit proxy authentication configuration from the auth proxy. + +
    +
  • This function makes a request to the Turnkey auth proxy to retrieve the current WalletKit configuration,
  • +
+ +including supported authentication methods, OAuth providers, and any custom proxy settings. + +
    +
  • Useful for dynamically configuring the client UI or authentication flows based on the proxy's capabilities.
  • +
  • Ensures that the client is aware of the latest proxy-side configuration, which may affect available login/signup options.
  • +
+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A promise that resolves to a `ProxyTGetWalletKitConfigResponse` object containing the proxy authentication configuration. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-get-session.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-get-session.mdx new file mode 100644 index 000000000..0020e2ef2 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-get-session.mdx @@ -0,0 +1,35 @@ +--- +title: "getSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Retrieves the session associated with the specified session key, or the active session by default. + +
    +
  • This function retrieves the session object from storage, using the provided session key or, if not specified, the current active session key.
  • +
  • If no session key is provided and there is no active session, it returns undefined.
  • +
  • Returns the session details, including public key, organization ID, user ID, and expiration.
  • +
+ + + + + + +session key to retrieve a specific session (defaults to the current active session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `Session` object containing the session details, or undefined if not found. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-get-wallet-providers.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-get-wallet-providers.mdx new file mode 100644 index 000000000..ae540186a --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-get-wallet-providers.mdx @@ -0,0 +1,30 @@ +--- +title: "getWalletProviders()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Retrieves wallet providers from the initialized wallet manager. + +
    +
  • Optionally filters providers by the specified blockchain chain.
  • +
  • Throws an error if the wallet manager is not initialized.
  • +
+ + + + + optional blockchain chain to filter the returned providers. + + + +A successful response returns the following fields: + + + A promise that resolves to an array of wallet providers. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-email.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-email.mdx new file mode 100644 index 000000000..5cc657c9b --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-email.mdx @@ -0,0 +1,50 @@ +--- +title: "handleAddEmail()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:408

+ + + +Handles the add user email flow. + +
    +
  • This function opens a modal with the UpdateEmail component, using a modified title and flow for adding and verifying the user's email address.
  • +
  • If an email is provided, it will immediately send an OTP request to the user and display the OTP verification modal.
  • +
  • Supports both manual entry and pre-filled email addresses, as well as custom modal titles and subtitles.
  • +
  • Uses the addEmailContinue helper to manage the OTP flow, verification, and update logic.
  • +
  • After successful verification and update, the user details state is refreshed and an optional success page can be shown.
  • +
  • Supports customizing the duration of the success page after update.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
  • +
+ + + + + + +parameter to specify the new email address. + + +subtitle for the modal. + + +duration (in ms) for the success page after update (default: 0, no success page). + + +title for the modal (defaults to "Connect an email" if the user does not have an email). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user that was changed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-oauth-provider.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-oauth-provider.mdx new file mode 100644 index 000000000..01ead8fd9 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-oauth-provider.mdx @@ -0,0 +1,44 @@ +--- +title: "handleAddOauthProvider()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:460

+ + + +Handles the addition of an OAuth provider for the user. + +
    +
  • This function opens a modal-driven flow for linking a new OAuth provider (Google, Apple, or Facebook) to the user's account.
  • +
  • It supports all enabled OAuth providers as defined in the configuration and dynamically triggers the appropriate OAuth flow.
  • +
  • Uses the handleGoogleOauth, handleAppleOauth, and handleFacebookOauth functions to initiate the provider-specific OAuth authentication process.
  • +
  • After successful authentication, the provider is linked to the user's account and a success page is shown.
  • +
  • Automatically refreshes the user details state after linking to ensure the latest provider list is available in the provider.
  • +
  • Optionally allows specifying the stamper to use for the addition (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
  • +
+ + + + + + +The name of the OAuth provider to add (OAuthProviders.GOOGLE, OAuthProviders.APPLE, OAuthProviders.FACEBOOK). + + +parameter to specify the stamper to use for the addition (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + + + + +A successful response returns the following fields: + + + A void promise. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-passkey.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-passkey.mdx new file mode 100644 index 000000000..d7318fd94 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-passkey.mdx @@ -0,0 +1,53 @@ +--- +title: "handleAddPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:513

+ + + +Handles the addition of a passkey (authenticator) for the user. + +
    +
  • This function opens a modal-driven flow for adding a new passkey authenticator (WebAuthn/FIDO2) to the user's account.
  • +
  • If a ``name`` or ``displayName`` is provided, those will be used for the passkey metadata; otherwise, defaults are generated based on the website and timestamp.
  • +
  • The passkey is created and linked to the specified user (by ``userId``) or the current session's user if not provided.
  • +
  • After successful addition, a success page is shown for the specified duration (or skipped if ``successPageDuration`` is 0).
  • +
  • Supports stamping the request with a specific stamper (``StamperType.Passkey``, ``StamperType.ApiKey``, or ``StamperType.Wallet``) for granular authentication control.
  • +
  • Automatically refreshes the user details state after successful addition to ensure the latest authenticators list is available in the provider.
  • +
  • Handles all error cases and throws a ``TurnkeyError`` with appropriate error codes.
  • +
+ + + + + + +display name for the passkey (shown to the user in the UI). + + +internal name for the passkey (for backend or developer reference). + + +parameter to stamp the request with a specific stamper (`StamperType.Passkey`, `StamperType.ApiKey`, or `StamperType.Wallet`). + + +duration (in ms) for the success page after addition (default: 0, no success page). + + +user ID to add the passkey for a specific user (defaults to current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the user's updated passkeys. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-phone-number.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-phone-number.mdx new file mode 100644 index 000000000..6a2464cef --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-phone-number.mdx @@ -0,0 +1,53 @@ +--- +title: "handleAddPhoneNumber()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:435

+ + + +Handles the add phone number flow. + +
    +
  • This function opens a modal with the UpdatePhoneNumber component for adding and verifying the user's phone number.
  • +
  • If a phone number is provided, it will immediately send an OTP request to the user and display the OTP verification modal.
  • +
  • Supports both manual entry and pre-filled phone numbers, as well as custom modal titles and subtitles.
  • +
  • Uses the addPhoneNumberContinue helper to manage the OTP flow, verification, and update logic.
  • +
  • After successful verification and update, the user details state is refreshed and an optional success page can be shown.
  • +
  • Supports customizing the duration of the success page after update.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
  • +
+ + + + + + +parameter to specify the formatted phone number. + + +parameter to specify the new phone number. + + +subtitle for the modal. + + +duration (in ms) for the success page after update (default: 0, no success page). + + +title for the modal. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user that was changed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-apple-oauth.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-apple-oauth.mdx new file mode 100644 index 000000000..e69087108 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-apple-oauth.mdx @@ -0,0 +1,56 @@ +--- +title: "handleAppleOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:169

+ + + +Handles the Apple OAuth flow. + +
    +
  • This function initiates the Apple OAuth flow by either redirecting the user to the Apple authorization page or opening it in a popup window.
  • +
  • The flow type is determined by the ``openInPage`` parameter: if true, the current page is redirected; if false (default), a popup window is used.
  • +
  • Generates a new ephemeral API key pair and uses its public key as the nonce for the OAuth request, ensuring cryptographic binding of the session.
  • +
  • Constructs the Apple OAuth URL with all required parameters, including client ID, redirect URI, response type, response mode, nonce, and state.
  • +
  • The ``state`` parameter includes the provider, flow type, public key, and any additional state parameters for tracking or custom logic.
  • +
  • If ``openInPage`` is true, the function redirects and returns a promise that resolves on redirect or times out after 5 minutes.
  • +
  • If ``openInPage`` is false, a popup window is opened and the function returns a promise that resolves when the flow completes, or rejects if the window is closed or times out.
  • +
  • On successful authentication, the function either calls the provided ``onOauthSuccess`` callback, triggers the ``onOauthRedirect`` callback from provider callbacks, or completes the OAuth flow internally by calling ``completeOauth``.
  • +
  • Handles all error cases, including missing configuration, popup failures, and timeouts, and throws a ``TurnkeyError`` with appropriate error codes.
  • +
+ + + + + + +Additional key-value pairs to include in the OAuth state parameter for custom tracking or logic. + + +The Apple Client ID to use (defaults to the client ID from configuration). + + +Callback function to handle the successful OAuth response (receives `{ oidcToken, providerName }`). + +onOauthSuccess params: +- oidcToken: The OIDC token received from the OAuth flow. +- providerName: The name of the OAuth provider ("apple"). + + +Whether to open the OAuth flow in the current page (redirect) or a popup window (default: false). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the OAuth flow is successfully initiated and completed, or rejects on error or timeout. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-private-key.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-private-key.mdx new file mode 100644 index 000000000..983a2d2b0 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-private-key.mdx @@ -0,0 +1,48 @@ +--- +title: "handleExportPrivateKey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:256

+ + + +handles the export private key flow. + +
    +
  • This function opens a modal with the ExportComponent for exporting a private key.
  • +
  • Uses Turnkey's export iframe flow to securely export private key material.
  • +
  • The export process encrypts the exported bundle to a target public key, which is generated and managed inside the iframe for maximum security.
  • +
  • A request is made to the Turnkey API to export the private key, encrypted to the target public key.
  • +
  • The resulting export bundle is injected into the iframe, where it is decrypted and displayed to the user.
  • +
  • If a custom iframe URL is used, a target public key can be provided explicitly.
  • +
  • Optionally allows specifying the stamper to use for the export (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
  • +
  • The modal-driven UI ensures the user is guided through the export process and can securely retrieve their exported material.
  • +
+ + + + + + +The ID of the private key to export. + + +The stamper to use for the export (Passkey, ApiKey, or Wallet). + + +The target public key to encrypt the export bundle to (required for custom iframe flows). + + + + + +A successful response returns the following fields: + + + A void promise. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet-account.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet-account.mdx new file mode 100644 index 000000000..6b5cda570 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet-account.mdx @@ -0,0 +1,48 @@ +--- +title: "handleExportWalletAccount()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:281

+ + + +Handles the export wallet account flow. + +
    +
  • This function opens a modal with the ExportComponent for exporting a wallet account.
  • +
  • Uses Turnkey's export iframe flow to securely export wallet account material.
  • +
  • The export process encrypts the exported bundle to a target public key, which is generated and managed inside the iframe for maximum security.
  • +
  • A request is made to the Turnkey API to export the wallet account, encrypted to the target public key.
  • +
  • The resulting export bundle is injected into the iframe, where it is decrypted and displayed to the user.
  • +
  • If a custom iframe URL is used, a target public key can be provided explicitly.
  • +
  • Optionally allows specifying the stamper to use for the export (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
  • +
  • The modal-driven UI ensures the user is guided through the export process and can securely retrieve their exported material.
  • +
+ + + + + + +The address of the wallet account to export. + + +The stamper to use for the export (Passkey, ApiKey, or Wallet). + + +The target public key to encrypt the export bundle to (required for custom iframe flows). + + + + + +A successful response returns the following fields: + + + A void promise. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet.mdx new file mode 100644 index 000000000..086a62eb2 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet.mdx @@ -0,0 +1,48 @@ +--- +title: "handleExportWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:233

+ + + +Handles the export wallet flow. + +
    +
  • This function opens a modal with the ExportComponent for exporting a wallet.
  • +
  • Uses Turnkey's export iframe flow to securely export wallet material.
  • +
  • The export process encrypts the exported bundle to a target public key, which is generated and managed inside the iframe for maximum security.
  • +
  • A request is made to the Turnkey API to export the wallet, encrypted to the target public key.
  • +
  • The resulting export bundle is injected into the iframe, where it is decrypted and displayed to the user.
  • +
  • If a custom iframe URL is used, a target public key can be provided explicitly.
  • +
  • Optionally allows specifying the stamper to use for the export (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
  • +
  • The modal-driven UI ensures the user is guided through the export process and can securely retrieve their exported material.
  • +
+ + + + + + +The stamper to use for the export (Passkey, ApiKey, or Wallet). + + +The target public key to encrypt the export bundle to (required for custom iframe flows). + + +The ID of the wallet to export. + + + + + +A successful response returns the following fields: + + + A void promise. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-facebook-oauth.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-facebook-oauth.mdx new file mode 100644 index 000000000..a487b26ed --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-facebook-oauth.mdx @@ -0,0 +1,57 @@ +--- +title: "handleFacebookOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:205

+ + + +Handles the Facebook OAuth flow. + +
    +
  • This function initiates the Facebook OAuth flow by either redirecting the user to the Facebook authorization page or opening it in a popup window.
  • +
  • The flow type is determined by the ``openInPage`` parameter: if true, the current page is redirected; if false (default), a popup window is used.
  • +
  • Generates a new ephemeral API key pair and uses its public key as the nonce for the OAuth request, ensuring cryptographic binding of the session.
  • +
  • Uses PKCE (Proof Key for Code Exchange) for enhanced security, generating a code verifier and challenge for the Facebook OAuth flow.
  • +
  • Constructs the Facebook OAuth URL with all required parameters, including client ID, redirect URI, response type, code challenge, nonce, and state.
  • +
  • The ``state`` parameter includes the provider, flow type, public key, and any additional state parameters for tracking or custom logic.
  • +
  • If ``openInPage`` is true, the function redirects and returns a promise that resolves on redirect or times out after 5 minutes.
  • +
  • If ``openInPage`` is false, a popup window is opened and the function returns a promise that resolves when the flow completes, or rejects if the window is closed or times out.
  • +
  • On successful authentication, the function either calls the provided ``onOauthSuccess`` callback, triggers the ``onOauthRedirect`` callback from provider callbacks, or completes the OAuth flow internally by calling ``completeOauth``.
  • +
  • Handles all error cases, including missing configuration, popup failures, and timeouts, and throws a ``TurnkeyError`` with appropriate error codes.
  • +
+ + + + + + +Additional key-value pairs to include in the OAuth state parameter for custom tracking or logic. + + +The Facebook Client ID to use (defaults to the client ID from configuration). + + +Callback function to handle the successful OAuth response (receives `{ oidcToken, providerName }`). + +onOauthSuccess params: +- oidcToken: The OIDC token received from the OAuth flow. +- providerName: The name of the OAuth provider ("facebook"). + + +Whether to open the OAuth flow in the current page (redirect) or a popup window (default: false). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the OAuth flow is successfully initiated and completed, or rejects on error or timeout. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-google-oauth.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-google-oauth.mdx new file mode 100644 index 000000000..bfedecab3 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-google-oauth.mdx @@ -0,0 +1,56 @@ +--- +title: "handleGoogleOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:134

+ + + +Handles the Google OAuth flow. + +
    +
  • This function initiates the Google OAuth flow by redirecting the user to the Google authorization page or opening it in a popup window.
  • +
  • It supports both "popup" and "redirect" flows, determined by the ``openInPage`` parameter.
  • +
  • Generates a new ephemeral API key pair and uses its public key as the nonce for the OAuth request, ensuring cryptographic binding of the session.
  • +
  • Constructs the Google OAuth URL with all required parameters, including client ID, redirect URI, response type, scope, nonce, and state.
  • +
  • The ``state`` parameter includes the provider, flow type, public key, and any additional state parameters for tracking or custom logic.
  • +
  • If ``openInPage`` is true, the current page is redirected to the Google OAuth URL and the function returns a promise that resolves on redirect or times out after 5 minutes.
  • +
  • If ``openInPage`` is false, a popup window is opened for the OAuth flow, and the function returns a promise that resolves when the flow completes or rejects if the window is closed or times out.
  • +
  • On successful authentication, the function either calls the provided ``onOauthSuccess`` callback, triggers the ``onOauthRedirect`` callback from provider callbacks, or completes the OAuth flow internally by calling ``completeOauth``.
  • +
  • Handles all error cases, including missing configuration, popup failures, and timeouts, and throws a ``TurnkeyError`` with appropriate error codes.
  • +
+ + + + + + +Additional key-value pairs to include in the OAuth state parameter for custom tracking or logic. + + +The Google Client ID to use (defaults to the client ID from configuration). + + +Callback function to handle the successful OAuth response (receives `{ oidcToken, providerName }`). + +onOauthSuccess params: +- oidcToken: The OIDC token received from the OAuth flow. +- providerName: The name of the OAuth provider ("google"). + + +Whether to open the OAuth flow in the current page (redirect) or a popup window (default: false). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the OAuth flow is successfully initiated and completed, or rejects on error or timeout. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-import-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-import-wallet.mdx new file mode 100644 index 000000000..f15d661ad --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-import-wallet.mdx @@ -0,0 +1,46 @@ +--- +title: "handleImportWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:303

+ + + +Handles the import flow. + +
    +
  • This function opens a modal with the ImportComponent for importing a wallet.
  • +
  • Supports importing wallets using an encrypted bundle, with optional default accounts or custom account parameters.
  • +
  • Allows users to specify default wallet accounts (address formats or account params) to pre-fill the import form.
  • +
  • Supports customizing the duration of the success page shown after a successful import.
  • +
  • Allows specifying the stamper to use for the import (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
  • +
  • Ensures the imported wallet is added to the user's wallet list and the provider state is refreshed.
  • +
+ + + + + + +array of default wallet accounts (v1AddressFormat[] or v1WalletAccountParams[]) to pre-fill the import form. + + +parameter to specify the stamper to use for the import (Passkey, ApiKey, or Wallet). + + +duration (in ms) for the success page after import (default: 0, no success page). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the new wallet's ID. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-link-external-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-link-external-wallet.mdx new file mode 100644 index 000000000..72c32c5cb --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-link-external-wallet.mdx @@ -0,0 +1,40 @@ +--- +title: "handleLinkExternalWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:596

+ + + +Handles the linking of an external wallet account to the user's Turnkey account. + +
    +
  • This function opens a modal with the LinkWalletModal component, allowing the user to select and connect an external wallet provider (such as MetaMask, Phantom, etc.).
  • +
  • It fetches the list of available wallet providers (for all supported chains) and passes them to the modal for user selection.
  • +
  • After a successful wallet connection, the provider state is refreshed to include the newly linked wallet account.
  • +
  • Optionally, a success page is shown for the specified duration after linking (default: 2000ms).
  • +
  • Supports both Ethereum and Solana wallet providers, and can be extended to additional chains as supported by Turnkey.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes if the client is not initialized or no active session is found.
  • +
+ + + + + + +duration (in ms) for the success page after linking (default: 2000ms). + + + + + +A successful response returns the following fields: + + + A void promise. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-login.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-login.mdx new file mode 100644 index 000000000..0fe036f1b --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-login.mdx @@ -0,0 +1,33 @@ +--- +title: "handleLogin()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:107

+ + + +Handles the login or sign-up flow. + +
    +
  • This function opens a modal with the AuthComponent, allowing the user to log in or sign up using any enabled authentication method (Passkey, Wallet, OTP, or OAuth).
  • +
  • It automatically determines available authentication methods based on the current provider configuration and proxy settings.
  • +
  • The modal-driven flow guides the user through the appropriate authentication steps, including social login if enabled.
  • +
  • After successful authentication, the provider state is updated and all relevant session, user, and wallet data are refreshed.
  • +
  • This function is typically used to trigger authentication from a UI button or navigation event.
  • +
+ + + +

No parameters.

+ + +A successful response returns the following fields: + + + A void promise. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-oauth-provider.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-oauth-provider.mdx new file mode 100644 index 000000000..eff91488f --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-oauth-provider.mdx @@ -0,0 +1,53 @@ +--- +title: "handleRemoveOauthProvider()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:485

+ + + +Handles the removal of an OAuth provider. + +
    +
  • This function opens a modal with the RemoveOAuthProvider component, allowing the user to confirm and remove an OAuth provider (such as Google, Apple, or Facebook) from their account.
  • +
  • It supports specifying the provider ID to remove, as well as optional modal title and subtitle for custom UI messaging.
  • +
  • After successful removal, the user details state is refreshed to reflect the updated list of linked OAuth providers.
  • +
  • Optionally, a callback can be provided to handle successful removal, receiving the updated list of provider IDs.
  • +
  • Supports customizing the duration of the success page shown after removal.
  • +
  • Allows specifying the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
  • +
+ + + + + + +The ID of the OAuth provider to remove (as found in the user's provider list). + + +parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +subtitle for the modal. + + +duration (in ms) for the success page after removal (default: 0, no success page). + + +title for the modal. + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of provider IDs that were removed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-passkey.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-passkey.mdx new file mode 100644 index 000000000..95eb65769 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-passkey.mdx @@ -0,0 +1,55 @@ +--- +title: "handleRemovePasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:541

+ + + +Handles the removal of a passkey (authenticator) for the user. + +
    +
  • This function opens a modal with the RemovePasskey component, allowing the user to confirm and remove a passkey authenticator from their account.
  • +
  • It supports specifying the authenticator ID to remove, as well as optional modal title and subtitle for custom UI messaging.
  • +
  • After successful removal, the user details state is refreshed to reflect the updated list of authenticators.
  • +
  • Supports customizing the duration of the success page shown after removal.
  • +
  • Allows specifying the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
  • +
+ + + + + + +The ID of the authenticator (passkey) to remove. + + +parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +subtitle for the modal. + + +duration (in ms) for the success page after removal (default: 0, no success page). + + +title for the modal. + + +user ID to remove the passkey for a specific user (defaults to current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of authenticator IDs that were removed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-email.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-email.mdx new file mode 100644 index 000000000..49c0feb96 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-email.mdx @@ -0,0 +1,40 @@ +--- +title: "handleRemoveUserEmail()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:609

+ + + +Handles the removal of a user's email address from their Turnkey account. + +
    +
  • This function opens a modal with the RemoveUserEmail component, allowing the user to confirm and remove their email address.
  • +
+ + + + + + +parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +duration (in ms) for the success page after removal (default: 0, no success page). + + +The user ID to remove the email for (defaults to current session's userId). + + + + + +A successful response returns the following fields: + + + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-phone-number.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-phone-number.mdx new file mode 100644 index 000000000..032d7b606 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-phone-number.mdx @@ -0,0 +1,40 @@ +--- +title: "handleRemoveUserPhoneNumber()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:624

+ + + +Handles the removal of a user's phone number from their Turnkey account. + +
    +
  • This function opens a modal with the RemoveUserPhoneNumber component, allowing the user to confirm and remove their phone number.
  • +
+ + + + + + +parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +duration (in ms) for the success page after removal (default: 0, no success page). + + +The user ID to remove the phone number for (defaults to current session's userId). + + + + + +A successful response returns the following fields: + + + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-sign-message.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-sign-message.mdx new file mode 100644 index 000000000..74b84cfac --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-sign-message.mdx @@ -0,0 +1,60 @@ +--- +title: "handleSignMessage()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:570

+ + + +Handles the signing of a message by displaying a modal for user interaction. + +
    +
  • This function opens a modal with the SignMessageModal component, prompting the user to review and approve the message signing request.
  • +
  • Supports signing with any wallet account managed by Turnkey, including externally linked wallets.
  • +
  • Allows for optional overrides of the encoding and hash function used for the payload, enabling advanced use cases or compatibility with specific blockchains.
  • +
  • Optionally displays a subtext in the modal for additional context or instructions to the user.
  • +
  • Returns a promise that resolves to a ``v1SignRawPayloadResult`` object containing the signed message, signature, and metadata.
  • +
+ + + + + + +whether to add the Ethereum prefix to the message (default: false). + + +encoding for the payload (defaults to the proper encoding for the account type). + + +hash function to use (defaults to the appropriate function for the account type). + + +The message to sign. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +subtext to display in the modal. + + +duration in seconds to display the success page after signing. + + +The wallet account to use for signing. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `v1SignRawPayloadResult` object containing the signed message. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-email.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-email.mdx new file mode 100644 index 000000000..2167d5bc1 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-email.mdx @@ -0,0 +1,47 @@ +--- +title: "handleUpdateUserEmail()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:328

+ + + +Handles the update user name flow. + +
    +
  • This function opens a modal with the UpdateUserName component for updating and verifying the user's name.
  • +
  • If a userName is provided, it will directly update the user name without showing the modal.
  • +
  • Uses updateUserName under the hood to perform the update and automatically refreshes the user details state after a successful update.
  • +
  • Optionally displays a success page after the update, with customizable duration.
  • +
  • Supports passing a custom title and subtitle for the modal UI.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
  • +
+ + + + + + + +subtitle for the modal. + + +duration (in ms) for the success page after update (default: 0, no success page). + + +title for the modal. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user that was changed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-name.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-name.mdx new file mode 100644 index 000000000..f56da1369 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-name.mdx @@ -0,0 +1,51 @@ +--- +title: "handleUpdateUserName()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:382

+ + + +Handles the update user email flow. + +
    +
  • This function opens a modal with the UpdateEmail component for updating and verifying the user's email address.
  • +
  • If an email is provided, it will immediately send an OTP request to the user and display the OTP verification modal.
  • +
  • Supports both manual entry and pre-filled email addresses, as well as custom modal titles and subtitles.
  • +
  • Uses the updateEmailContinue helper to manage the OTP flow, verification, and update logic.
  • +
  • After successful verification and update, the user details state is refreshed and an optional success page can be shown.
  • +
  • Supports customizing the duration of the success page after update.
  • +
  • Handles all error cases and throws a TurnkeyError with appropriate error codes.
  • +
+ + + + + + +parameter to specify the stamper to use for the update (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +subtitle for the modal. + + +duration (in ms) for the success page after update (default: 0, no success page). + + +title for the modal. + + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user that was changed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-phone-number.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-phone-number.mdx new file mode 100644 index 000000000..b819920d2 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-phone-number.mdx @@ -0,0 +1,53 @@ +--- +title: "handleUpdateUserPhoneNumber()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:355

+ + + +Handles the update user phone number flow. + +
    +
  • This function opens a modal with the UpdatePhoneNumber component for updating and verifying the user's phone number.
  • +
  • If a phoneNumber is provided, it will directly send an OTP request to the user and display the OTP verification modal.
  • +
  • Supports both manual entry and pre-filled phone numbers, as well as custom modal titles and subtitles.
  • +
  • Uses the updatePhoneNumberContinue helper to manage the OTP flow, verification, and update logic.
  • +
  • After successful verification and update, the user details state is refreshed and an optional success page can be shown.
  • +
  • Supports customizing the duration of the success page after update.
  • +
  • Throws a TurnkeyError if the client is not initialized, no active session is found, SMS OTP is not enabled, or if there is an error updating the phone number.
  • +
+ + + + + + +parameter to specify the formatted phone number. + + +parameter to specify the new phone number. + + +subtitle for the modal. + + +duration for the success page (default: 0, no success page). + + +title for the modal. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user that was changed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-import-private-key.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-import-private-key.mdx new file mode 100644 index 000000000..642b22514 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-import-private-key.mdx @@ -0,0 +1,52 @@ +--- +title: "importPrivateKey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Imports a private key from an encrypted bundle. + +
    +
  • This function imports a private key using the provided encrypted bundle.
  • +
  • If a userId is provided, the private key will be imported for that specific user; otherwise, it uses the current session's userId.
  • +
  • Requires address formats to
  • +
  • Automatically infers the cryptographic curve used to generate the private key based on the address format (can be optionally overriden if needed).
  • +
  • The encrypted bundle MUST be encrypted to ensure security.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + + +the cryptographic curve used to generate a given private key + + +encrypted bundle containing the private key key material and metadata. + + +name of the private key to create upon import. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to import the wallet for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the ID of the imported wallet. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-import-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-import-wallet.mdx new file mode 100644 index 000000000..a63a6d65f --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-import-wallet.mdx @@ -0,0 +1,50 @@ +--- +title: "importWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Imports a wallet from an encrypted bundle. + +
    +
  • This function imports a wallet using the provided encrypted bundle and creates accounts based on the provided parameters.
  • +
  • If a userId is provided, the wallet will be imported for that specific user; otherwise, it uses the current session's userId.
  • +
  • If an accounts array is provided, those accounts will be created in the imported wallet; otherwise, default Ethereum and Solana accounts will be created.
  • +
  • The encrypted bundle MUST be encrypted to
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +array of account parameters to create in the imported wallet (defaults to standard Ethereum and Solana accounts). + + +encrypted bundle containing the wallet seed phrase and metadata. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to import the wallet for a specific user (defaults to the current session's userId). + + +name of the wallet to create upon import. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the ID of the imported wallet. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-init-otp.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-init-otp.mdx new file mode 100644 index 000000000..957459a00 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-init-otp.mdx @@ -0,0 +1,38 @@ +--- +title: "initOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Initializes the OTP process by sending an OTP code to the provided contact. + +
    +
  • This function initiates the OTP flow by sending a one-time password (OTP) code to the user's contact information (email address or phone number) via the auth proxy.
  • +
  • Supports both email and SMS OTP types.
  • +
  • Returns an OTP ID that is required for subsequent OTP verification.
  • +
+ + + + + + +contact information for the user (e.g., email address or phone number). + + +type of OTP to initialize (OtpType.Email or OtpType.Sms). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the OTP ID required for verification. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-login-or-signup-with-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-login-or-signup-with-wallet.mdx new file mode 100644 index 000000000..5dcd9f4d7 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-login-or-signup-with-wallet.mdx @@ -0,0 +1,47 @@ +--- +title: "loginOrSignupWithWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Logs in an existing user or signs up a new user using a wallet, creating a new sub-organization if needed. + +
    +
  • This function attempts to log in the user by stamping a login request with the provided wallet.
  • +
  • If the wallet’s public key is not associated with an existing sub-organization, a new one is created.
  • +
  • Handles both wallet authentication and sub-organization creation in a single flow.
  • +
  • For Ethereum wallets, derives the public key from the signed request header; for Solana wallets, retrieves it directly from the wallet.
  • +
  • Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
+ + + + + + +optional parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +session expiration time in seconds (defaults to the configured default). + + +session key to use for storing the session (defaults to the default session key). + + +wallet provider to use for authentication. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the sub-organization (new or existing). + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-oauth.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-oauth.mdx new file mode 100644 index 000000000..c535d9c5e --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-oauth.mdx @@ -0,0 +1,45 @@ +--- +title: "loginWithOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Logs in a user using OAuth authentication. + +
    +
  • This function logs in a user using the provided OIDC token and public key.
  • +
  • Optionally invalidates any existing sessions for the user if ``invalidateExisting`` is set to true.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Handles cleanup of unused key pairs if login fails.
  • +
+ + + + + + +flag to invalidate existing sessions for the user. + + +OIDC token received after successful authentication with the OAuth provider. + + +public key to use for authentication. Must be generated prior to calling this function. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-otp.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-otp.mdx new file mode 100644 index 000000000..324149400 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-otp.mdx @@ -0,0 +1,46 @@ +--- +title: "loginWithOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Logs in a user using an OTP verification token. + +
    +
  • This function logs in a user using the verification token received after OTP verification (from email or SMS).
  • +
  • If a public key is not provided, a new API key pair will be generated for authentication.
  • +
  • Optionally invalidates any existing sessions for the user if ``invalidateExisting`` is set to true.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Handles cleanup of unused key pairs if login fails.
  • +
+ + + + + + +flag to invalidate existing session for the user. + + +public key to use for authentication. If not provided, a new key pair will be generated. + + +session key to use for session creation (defaults to the default session key). + + +verification token received after OTP verification. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-passkey.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-passkey.mdx new file mode 100644 index 000000000..3816bb688 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-passkey.mdx @@ -0,0 +1,43 @@ +--- +title: "loginWithPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Logs in a user using a passkey, optionally specifying the public key, session key, and session expiration. + +
    +
  • This function initiates the login process with a passkey and handles session creation and storage.
  • +
  • If a public key is not provided, a new key pair will be generated for authentication.
  • +
  • If a session key is not provided, the default session key will be used.
  • +
  • The session expiration can be customized via the expirationSeconds parameter.
  • +
  • Handles cleanup of unused key pairs if login fails.
  • +
+ + + + + + +session expiration time in seconds (defaults to the configured default). + + +public key to use for authentication. If not provided, a new key pair will be generated. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-wallet.mdx new file mode 100644 index 000000000..197b329a1 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-login-with-wallet.mdx @@ -0,0 +1,46 @@ +--- +title: "loginWithWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Logs in a user using the specified wallet provider. + +
    +
  • This function logs in a user by authenticating with the provided wallet provider via a wallet-based signature.
  • +
  • If a public key is not provided, a new one will be generated for authentication.
  • +
  • Optionally accepts a custom session key and session expiration time.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Throws an error if a public key cannot be found or generated, or if the login process fails.
  • +
+ + + + + + +optional session expiration time in seconds (defaults to the configured default). + + +optional public key to associate with the session (generated if not provided). + + +optional key to store the session under (defaults to the default session key). + + +wallet provider to use for authentication. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the created session token. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-logout.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-logout.mdx new file mode 100644 index 000000000..65d404b32 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-logout.mdx @@ -0,0 +1,35 @@ +--- +title: "logout()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Logs out the current client session. + +
    +
  • This function clears the specified session and removes any associated key pairs from storage.
  • +
  • If a sessionKey is provided, it logs out from that session; otherwise, it logs out from the active session.
  • +
  • Cleans up any api keys associated with the session.
  • +
+ + + + + + +session key to specify which session to log out from (defaults to the active session). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the logout process is complete. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-session.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-session.mdx new file mode 100644 index 000000000..e3281cb48 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-session.mdx @@ -0,0 +1,50 @@ +--- +title: "refreshSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Refreshes the session associated with the specified session key, or the active session by default. + +
    +
  • This function refreshes the session and updates the session token and key pair associated with the given session key.
  • +
  • If a sessionKey is provided, it will refresh the session under that key; otherwise, it will use the current active session key.
  • +
  • Optionally allows specifying a new expiration time for the session, a custom public key, and whether to invalidate the existing session after refreshing.
  • +
  • Makes a request to the Turnkey API to stamp a new login and stores the refreshed session token.
  • +
  • Automatically manages key pair cleanup and session storage to ensure consistency.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +expiration time in seconds for the refreshed session (defaults to the configured default). + + +flag to invalidate the existing session before refreshing (defaults to false). + + +public key to use for the refreshed session (if not provided, a new key pair will be generated). + + +session key to refresh the session under (defaults to the active session key). + + +parameter to stamp the request with a specific stamper. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `TStampLoginResponse` object containing the refreshed session details. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-user.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-user.mdx new file mode 100644 index 000000000..c58f955fa --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-user.mdx @@ -0,0 +1,44 @@ +--- +title: "refreshUser()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:72

+ + + +Refreshes the user details. + +
    +
  • This function fetches the latest user details for the current session (or optionally for a specific user/organization if provided)
  • +
+ +and updates the ``user`` state variable in the provider. + +
    +
  • If a ``stampWith`` parameter is provided, it will use that stamper to fetch the user details (supports Passkey, ApiKey, or Wallet stampers).
  • +
  • Automatically handles error reporting via the configured callbacks.
  • +
  • Typically used after authentication, user profile updates, or linking/unlinking authenticators to ensure the provider state is up to date.
  • +
  • If no user is found, the state will not be updated.
  • +
+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the user details are successfully refreshed and state is updated. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-wallets.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-wallets.mdx new file mode 100644 index 000000000..b824e2ae9 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-refresh-wallets.mdx @@ -0,0 +1,54 @@ +--- +title: "refreshWallets()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ +

Defined in: react-wallet-kit/src/providers/client/Types.tsx:92

+ + + +Refreshes the wallets state for the current user session. + +
    +
  • This function fetches the latest list of wallets associated with the current session or user,
  • +
+ +and updates the ``wallets`` state variable in the provider. + +
    +
  • If a ``stampWith`` parameter is provided, it will use that stamper to fetch the wallets
  • +
+ +(supports Passkey, ApiKey, or Wallet stampers for granular authentication control). + +
    +
  • Automatically handles error reporting via the configured callbacks.
  • +
  • Typically used after wallet creation, import, export, account changes, or authentication
  • +
+ +to ensure the provider state is up to date. + +
    +
  • If no wallets are found, the state will be set to an empty array.
  • +
+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + + + + +A successful response returns the following fields: + + + A promise that resolves when the wallets are successfully refreshed and state is updated. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-remove-oauth-providers.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-oauth-providers.mdx new file mode 100644 index 000000000..1fca54aaa --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-oauth-providers.mdx @@ -0,0 +1,43 @@ +--- +title: "removeOauthProviders()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Removes a list of OAuth providers from the user. + +
    +
  • This function removes OAuth providers (e.g., Google, Apple) from the user's account.
  • +
  • If a userId is provided, it removes the providers for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Returns an array of remaining provider IDs associated with the user after removal.
  • +
+ + + + + + +IDs of the OAuth providers to remove. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove the provider for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of provider IDs that were removed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-remove-passkeys.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-passkeys.mdx new file mode 100644 index 000000000..f25416b87 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-passkeys.mdx @@ -0,0 +1,43 @@ +--- +title: "removePasskeys()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Removes passkeys (authenticator) from the user. + +
    +
  • This function removes passkeys (WebAuthn/FIDO2 authenticators) from the user's account.
  • +
  • If a userId is provided, it removes the passkeys for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Returns an array of remaining authenticator IDs for the user after removal.
  • +
+ + + + + + +IDs of the authenticators (passkeys) to remove. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove the passkeys for a specific user (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an array of authenticator IDs that were removed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-email.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-email.mdx new file mode 100644 index 000000000..800303d68 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-email.mdx @@ -0,0 +1,39 @@ +--- +title: "removeUserEmail()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Removes the user's email address. + +
    +
  • This function removes the user's email address by setting it to an empty string.
  • +
  • If a userId is provided, it removes the email for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove a specific user's email address (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user whose email was removed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-phone-number.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-phone-number.mdx new file mode 100644 index 000000000..a034a6f75 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-phone-number.mdx @@ -0,0 +1,39 @@ +--- +title: "removeUserPhoneNumber()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Removes the user's phone number. + +
    +
  • This function removes the user's phone number by setting it to an empty string.
  • +
  • If a userId is provided, it removes the phone number for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to remove a specific user's phone number (defaults to the current session's userId). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the user whose phone number was removed. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-set-active-session.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-set-active-session.mdx new file mode 100644 index 000000000..bde4db65c --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-set-active-session.mdx @@ -0,0 +1,36 @@ +--- +title: "setActiveSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Sets the active session to the specified session key. + +
    +
  • This function updates the ``activeSessionKey`` in persistent storage to the specified session key.
  • +
  • Ensures that subsequent operations use the session associated with this key as the active session.
  • +
  • Does not validate whether the session key exists or is valid; it simply updates the pointer.
  • +
  • Useful for switching between multiple stored sessions or restoring a previous session context.
  • +
+ + + + + + +session key to set as the active session. + + + + + +A successful response returns the following fields: + + + A promise that resolves when the active session key is successfully set. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-sign-and-send-transaction.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-and-send-transaction.mdx new file mode 100644 index 000000000..46499b28e --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-and-send-transaction.mdx @@ -0,0 +1,54 @@ +--- +title: "signAndSendTransaction()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Signs and broadcasts a transaction using the specified wallet account. + +
    +
  • For **connected wallets**:
  • +
  • Calls the wallet’s native ``signAndSendTransaction`` method.
  • +
  • Does **not** require an ``rpcUrl``.
  • +
+ +
    +
  • For **embedded wallets**:
  • +
  • Signs the transaction using the Turnkey API.
  • +
  • Requires an ``rpcUrl`` to broadcast the transaction.
  • +
  • Broadcasts the transaction using a JSON-RPC client.
  • +
+ + + + + + +required for embedded wallets to broadcast the signed transaction. + + +optional stamper to tag the signing request. + + +transaction type (e.g., "TRANSACTION_TYPE_SOLANA"). + + +unsigned transaction (serialized string). + + +wallet account to use for signing and sending. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a transaction signature or hash. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-sign-message.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-message.mdx new file mode 100644 index 000000000..8a5c542c0 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-message.mdx @@ -0,0 +1,64 @@ +--- +title: "signMessage()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Signs a message using the specified wallet account. + +
    +
  • Supports both embedded and connected wallets.
  • +
  • For **connected wallets**:
  • +
  • Delegates signing to the wallet provider’s native signing method.
  • +
  • **Important:** For Ethereum wallets (e.g., MetaMask), signatures follow [EIP-191](https://eips.ethereum.org/EIPS/eip-191).
  • +
+ +The message is automatically prefixed with ``"\x19Ethereum Signed Message:\n" + message length`` before signing. As a result, this signature **cannot be used as a raw transaction signature** or broadcast on-chain. + +
    +
  • For **embedded wallets**, uses the Turnkey API to sign the message directly.
  • +
  • Automatically handles message encoding and hashing based on the wallet account’s address format,
  • +
+ +unless explicitly overridden. + + + + + + +whether to prefix the message with Ethereum's `"\x19Ethereum Signed Message:\n"` string. + - If `true` (default for Ethereum), the message is prefixed before signing. + - If `false`: + - Connected wallets will throw an error because they always prefix automatically. + - Embedded wallets will sign the raw message without any prefix. + + +override for the payload encoding (defaults to the encoding appropriate for the address type). + + +override for the hash function (defaults to the hash function appropriate for the address type). + + +message to sign. + + +stamper to tag the signing request (e.g., Passkey, ApiKey, or Wallet). + + +wallet account to use for signing. + + + + + +A successful response returns the following fields: + + + A promise resolving to a `v1SignRawPayloadResult` containing the signature and metadata. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-sign-transaction.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-transaction.mdx new file mode 100644 index 000000000..38697f419 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-transaction.mdx @@ -0,0 +1,46 @@ +--- +title: "signTransaction()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Signs a transaction using the specified wallet account. + +
    +
  • This function signs a blockchain transaction using the provided wallet address and transaction data.
  • +
  • Supports all Turnkey-supported blockchain networks (e.g., Ethereum, Solana, Tron).
  • +
  • Automatically determines the appropriate signing method based on the transaction type.
  • +
  • Delegates signing to the Turnkey API, which returns the signed transaction and related metadata.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +type of transaction (e.g., "TRANSACTION_TYPE_ETHEREUM", "TRANSACTION_TYPE_SOLANA", "TRANSACTION_TYPE_TRON"). + + +unsigned transaction data (serialized as a string) to be signed. + + +wallet account to use for signing the transaction. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a `TSignTransactionResponse` object containing the signed transaction and any additional signing metadata. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-oauth.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-oauth.mdx new file mode 100644 index 000000000..c204a46c6 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-oauth.mdx @@ -0,0 +1,48 @@ +--- +title: "signUpWithOauth()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Signs up a user using OAuth authentication. + +
    +
  • This function creates a new sub-organization for the user using the provided OIDC token, public key, and provider name.
  • +
  • Handles the full OAuth sign-up flow, including sub-organization creation and session management.
  • +
  • Optionally accepts additional sub-organization creation parameters and a custom session key.
  • +
  • After successful sign-up, automatically logs in the user and returns a signed JWT session token.
  • +
+ + + + + + +parameters for sub-organization creation (e.g., authenticators, user metadata). + + +OIDC token received after successful authentication with the OAuth provider. + + +name of the OAuth provider (e.g., "Google", "Apple"). + + +public key to associate with the new sub-organization. + + +session key to use for session creation (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-otp.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-otp.mdx new file mode 100644 index 000000000..b6d652222 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-otp.mdx @@ -0,0 +1,52 @@ +--- +title: "signUpWithOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Signs up a user using an OTP verification token. + +
    +
  • This function signs up a user using the verification token received after OTP verification (from email or SMS).
  • +
  • Creates a new sub-organization for the user with the provided parameters and associates the contact (email or phone) with the sub-organization.
  • +
  • Automatically generates a new API key pair for authentication and session management.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided.
  • +
  • Handles both email and SMS OTP types, and supports additional sub-organization creation parameters.
  • +
+ + + + + + +contact information for the user (e.g., email address or phone number). + + +parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +flag to invalidate existing session for the user. + + +type of OTP being used (OtpType.Email or OtpType.Sms). + + +session key to use for session creation (defaults to the default session key). + + +verification token received after OTP verification. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-passkey.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-passkey.mdx new file mode 100644 index 000000000..ac6db19a3 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-passkey.mdx @@ -0,0 +1,46 @@ +--- +title: "signUpWithPasskey()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Signs up a user using a passkey, creating a new sub-organization and session. + +
    +
  • This function creates a new passkey authenticator and uses it to register a new sub-organization for the user.
  • +
  • Handles both passkey creation and sub-organization creation in a single flow.
  • +
  • Optionally accepts additional sub-organization parameters, a custom session key, a custom passkey display name, and a custom session expiration.
  • +
  • Automatically generates a new API key pair for authentication and session management.
  • +
  • Stores the resulting session token and manages cleanup of unused key pairs.
  • +
+ + + + + + +parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +session expiration time in seconds (defaults to the configured default). + + +display name for the passkey (defaults to a generated name based on the current timestamp). + + +session key to use for storing the session (defaults to the default session key). + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-wallet.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-wallet.mdx new file mode 100644 index 000000000..7d95ecd6e --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-wallet.mdx @@ -0,0 +1,46 @@ +--- +title: "signUpWithWallet()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Signs up a user using a wallet, creating a new sub-organization and session. + +
    +
  • This function creates a new wallet authenticator and uses it to register a new sub-organization for the user.
  • +
  • Handles both wallet authentication and sub-organization creation in a single flow.
  • +
  • Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration.
  • +
  • Automatically generates additional API key pairs for authentication and session management.
  • +
  • Stores the resulting session token under the specified session key, or the default session key if not provided, and manages cleanup of unused key pairs.
  • +
+ + + + + + +parameters for creating a sub-organization (e.g., authenticators, user metadata). + + +session expiration time in seconds (defaults to the configured default). + + +session key to use for storing the session (defaults to the default session key). + + +wallet provider to use for authentication. + + + + + +A successful response returns the following fields: + + + A promise that resolves to a signed JWT session token for the new sub-organization. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-store-session.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-store-session.mdx new file mode 100644 index 000000000..d807f71d0 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-store-session.mdx @@ -0,0 +1,40 @@ +--- +title: "storeSession()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Stores a session token and updates the session associated with the specified session key, or by default the active session. + +
    +
  • This function parses and stores a signed JWT session token in local storage, associating it with the given session key.
  • +
  • If a sessionKey is provided, the session will be stored under that key; otherwise, it will use the default session key.
  • +
  • If a session already exists for the session key, its associated key pair will be deleted before storing the new session.
  • +
  • After storing the session, any unused key pairs are automatically cleared from storage.
  • +
  • Ensures that session management is consistent and prevents orphaned key pairs.
  • +
+ + + + + + +session key to store the session under (defaults to the default session key). + + +JWT session token to store. + + + + + +A successful response returns the following fields: + + + A promise that resolves when the session is successfully stored. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-account-chain.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-account-chain.mdx new file mode 100644 index 000000000..f9bf0882d --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-account-chain.mdx @@ -0,0 +1,42 @@ +--- +title: "switchWalletAccountChain()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Switches the wallet provider associated with a given wallet account to a different chain. + +
    +
  • Requires the wallet manager and its connector to be initialized
  • +
  • Only works for connected wallet accounts
  • +
  • Looks up the provider for the given account address
  • +
  • Does nothing if the provider is already on the desired chain.
  • +
+ + + + + + +The target chain, specified as a chain ID string or a SwitchableChain object. + + +The wallet account whose provider should be switched. + + +Optional list of wallet providers to search; falls back to `getWalletProviders()` if omitted. + + + + + +A successful response returns the following fields: + + + A promise that resolves once the chain switch is complete. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-provider-chain.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-provider-chain.mdx new file mode 100644 index 000000000..5505d4778 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-provider-chain.mdx @@ -0,0 +1,35 @@ +--- +title: "switchWalletProviderChain()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Switches the specified wallet provider to a different blockchain chain. + +
    +
  • Requires the wallet manager and its connector to be initialized.
  • +
  • The wallet provider must have at least one connected address.
  • +
  • Does nothing if the wallet provider is already on the desired chain.
  • +
+ + + + + wallet provider to switch. + + + + target chain as a chain ID string or SwitchableChain object. + + + +A successful response returns the following fields: + + + A promise that resolves once the chain switch is complete. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-email.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-email.mdx new file mode 100644 index 000000000..3a21cbe1a --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-email.mdx @@ -0,0 +1,46 @@ +--- +title: "updateUserEmail()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Updates the user's email address. + +
    +
  • This function updates the user's email address and, if provided, verifies it using a verification token (typically from an OTP flow).
  • +
  • If a userId is provided, it updates the email for that specific user; otherwise, it uses the current session's userId.
  • +
  • If a verificationToken is not provided, the email will be updated but will not be marked as verified.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Handles session management and error reporting for both update and verification flows.
  • +
+ + + + + + +new email address to set for the user. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to update a specific user's email (defaults to the current session's userId). + + +verification token from OTP email verification (required if verifying the email). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the updated user. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-name.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-name.mdx new file mode 100644 index 000000000..2364c27db --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-name.mdx @@ -0,0 +1,43 @@ +--- +title: "updateUserName()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Updates the user's name. + +
    +
  • This function updates the user's display name.
  • +
  • If a userId is provided, it updates the name for that specific user; otherwise, it uses the current session's userId.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet).
  • +
  • Handles session management and error reporting for the update flow.
  • +
+ + + + + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to update a specific user's name (defaults to the current session's userId). + + +new name to set for the user. + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the updated user. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-phone-number.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-phone-number.mdx new file mode 100644 index 000000000..b5af982b0 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-update-user-phone-number.mdx @@ -0,0 +1,46 @@ +--- +title: "updateUserPhoneNumber()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Updates the user's phone number. + +
    +
  • This function updates the user's phone number and, if provided, verifies it using a verification token (from an OTP flow).
  • +
  • If a userId is provided, it updates the phone number for that specific user; otherwise, it uses the current session's userId.
  • +
  • If a verificationToken is not provided, the phone number will be updated but will not be marked as verified.
  • +
  • Automatically ensures an active session exists before making the request.
  • +
  • Handles session management and error reporting for both update and verification flows.
  • +
+ + + + + + +new phone number to set for the user. + + +parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). + + +user ID to update a specific user's phone number (defaults to the current session's userId). + + +verification token from OTP phone verification (required if verifying the phone number). + + + + + +A successful response returns the following fields: + + + A promise that resolves to the userId of the updated user. + diff --git a/generated-docs/formatted/react-wallet-kit/client-context-type-verify-otp.mdx b/generated-docs/formatted/react-wallet-kit/client-context-type-verify-otp.mdx new file mode 100644 index 000000000..953389927 --- /dev/null +++ b/generated-docs/formatted/react-wallet-kit/client-context-type-verify-otp.mdx @@ -0,0 +1,51 @@ +--- +title: "verifyOtp()" +--- + +import { H3Bordered } from "/snippets/h3-bordered.mdx"; +import { NestedParam } from "/snippets/nested-param.mdx"; + +

Package: react-wallet-kit

+ + + +Verifies the OTP code sent to the user. + +
    +
  • This function verifies the OTP code entered by the user against the OTP sent to their contact information (email or phone) using the auth proxy.
  • +
  • If verification is successful, it returns the sub-organization ID associated with the contact (if it exists) and a verification token.
  • +
  • The verification token can be used for subsequent login or sign-up flows.
  • +
  • Handles both email and SMS OTP types.
  • +
+ + + + + + +contact information for the user (e.g., email address or phone number). + + +OTP code entered by the user. + + +ID of the OTP to verify (returned from `initOtp`). + + +type of OTP being verified (OtpType.Email or OtpType.Sms). + + + + + +A successful response returns the following fields: + + + A promise that resolves to an object containing: + - subOrganizationId: sub-organization ID if the contact is already associated with a sub-organization, or an empty string if not. + - verificationToken: verification token to be used for login or sign-up. + + + + + diff --git a/generated-docs/merged-sdk-docs.json b/generated-docs/merged-sdk-docs.json deleted file mode 100644 index 9a1c07162..000000000 --- a/generated-docs/merged-sdk-docs.json +++ /dev/null @@ -1,2184 +0,0 @@ -{ - "navigation": { - "tabs": [ - { - "tab": "SDK Reference", - "groups": [ - { - "group": "SDK Reference", - "pages": [ - { - "group": "sdks", - "pages": [ - { - "group": "_media", - "pages": [] - }, - { - "group": "api-key-stamper", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": ["sdks/api-key-stamper/ApiKeyStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": [ - "sdks/api-key-stamper/index/ApiKeyStamper/readme" - ] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/api-key-stamper/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "pointDecode", - "pages": [ - "sdks/api-key-stamper/index/pointDecode/readme" - ] - }, - "sdks/api-key-stamper/index/readme", - { - "group": "signWithApiKey", - "pages": [ - "sdks/api-key-stamper/index/signWithApiKey/readme" - ] - } - ] - }, - "sdks/api-key-stamper/readme" - ] - }, - { - "group": "cosmjs", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/cosmjs/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/cosmjs/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyDirectWallet", - "pages": [ - "sdks/cosmjs/index/TurnkeyDirectWallet/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/cosmjs/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "fetchCompressedPublicKey", - "pages": [ - "sdks/cosmjs/index/fetchCompressedPublicKey/readme" - ] - }, - "sdks/cosmjs/index/readme" - ] - }, - "sdks/cosmjs/readme" - ] - }, - { - "group": "crypto", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "buildAdditionalAssociatedData", - "pages": [ - "sdks/crypto/index/buildAdditionalAssociatedData/readme" - ] - }, - { - "group": "compressRawPublicKey", - "pages": [ - "sdks/crypto/index/compressRawPublicKey/readme" - ] - }, - { - "group": "decryptCredentialBundle", - "pages": [ - "sdks/crypto/index/decryptCredentialBundle/readme" - ] - }, - { - "group": "decryptExportBundle", - "pages": [ - "sdks/crypto/index/decryptExportBundle/readme" - ] - }, - { - "group": "encryptPrivateKeyToBundle", - "pages": [ - "sdks/crypto/index/encryptPrivateKeyToBundle/readme" - ] - }, - { - "group": "encryptWalletToBundle", - "pages": [ - "sdks/crypto/index/encryptWalletToBundle/readme" - ] - }, - { - "group": "extractPrivateKeyFromPKCS8Bytes", - "pages": [ - "sdks/crypto/index/extractPrivateKeyFromPKCS8Bytes/readme" - ] - }, - { - "group": "formatHpkeBuf", - "pages": ["sdks/crypto/index/formatHpkeBuf/readme"] - }, - { - "group": "fromDerSignature", - "pages": [ - "sdks/crypto/index/fromDerSignature/readme" - ] - }, - { - "group": "generateP256KeyPair", - "pages": [ - "sdks/crypto/index/generateP256KeyPair/readme" - ] - }, - { - "group": "getPublicKey", - "pages": ["sdks/crypto/index/getPublicKey/readme"] - }, - { - "group": "hpkeAuthEncrypt", - "pages": [ - "sdks/crypto/index/hpkeAuthEncrypt/readme" - ] - }, - { - "group": "hpkeDecrypt", - "pages": ["sdks/crypto/index/hpkeDecrypt/readme"] - }, - { - "group": "hpkeEncrypt", - "pages": ["sdks/crypto/index/hpkeEncrypt/readme"] - }, - "sdks/crypto/index/readme", - { - "group": "toDerSignature", - "pages": ["sdks/crypto/index/toDerSignature/readme"] - }, - { - "group": "uncompressRawPublicKey", - "pages": [ - "sdks/crypto/index/uncompressRawPublicKey/readme" - ] - }, - { - "group": "verifyStampSignature", - "pages": [ - "sdks/crypto/index/verifyStampSignature/readme" - ] - } - ] - }, - "sdks/crypto/readme" - ] - }, - { - "group": "eip-1193-provider", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": [ - "sdks/eip-1193-provider/documents/docs/readme" - ] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyEIP1193Provider", - "pages": [ - "sdks/eip-1193-provider/index/TurnkeyEIP1193Provider/readme" - ] - }, - { - "group": "createEIP1193Provider", - "pages": [ - "sdks/eip-1193-provider/index/createEIP1193Provider/readme" - ] - }, - "sdks/eip-1193-provider/index/readme" - ] - }, - "sdks/eip-1193-provider/readme" - ] - }, - { - "group": "encoding", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "DEFAULT_JWK_MEMBER_BYTE_LENGTH", - "pages": [ - "sdks/encoding/index/DEFAULT_JWK_MEMBER_BYTE_LENGTH/readme" - ] - }, - { - "group": "base64StringToBase64UrlEncodedString", - "pages": [ - "sdks/encoding/index/base64StringToBase64UrlEncodedString/readme" - ] - }, - { - "group": "hexStringToBase64url", - "pages": [ - "sdks/encoding/index/hexStringToBase64url/readme" - ] - }, - { - "group": "hexToAscii", - "pages": ["sdks/encoding/index/hexToAscii/readme"] - }, - { - "group": "normalizePadding", - "pages": [ - "sdks/encoding/index/normalizePadding/readme" - ] - }, - "sdks/encoding/index/readme", - { - "group": "stringToBase64urlString", - "pages": [ - "sdks/encoding/index/stringToBase64urlString/readme" - ] - }, - { - "group": "uint8ArrayFromHexString", - "pages": [ - "sdks/encoding/index/uint8ArrayFromHexString/readme" - ] - }, - { - "group": "uint8ArrayToHexString", - "pages": [ - "sdks/encoding/index/uint8ArrayToHexString/readme" - ] - } - ] - }, - "sdks/encoding/readme" - ] - }, - { - "group": "ethers", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/ethers/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/ethers/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/ethers/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeySigner", - "pages": ["sdks/ethers/index/TurnkeySigner/readme"] - }, - "sdks/ethers/index/readme", - { - "group": "serializeSignature", - "pages": [ - "sdks/ethers/index/serializeSignature/readme" - ] - } - ] - }, - "sdks/ethers/readme" - ] - }, - { - "group": "http", - "pages": [ - { - "group": "TurnkeyClient", - "pages": ["sdks/http/TurnkeyClient/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "InvalidArgumentError", - "pages": [ - "sdks/http/index/InvalidArgumentError/readme" - ] - }, - { - "group": "SignedRequest", - "pages": ["sdks/http/index/SignedRequest/readme"] - }, - { - "group": "TActivity", - "pages": ["sdks/http/index/TActivity/readme"] - }, - { - "group": "TActivityId", - "pages": ["sdks/http/index/TActivityId/readme"] - }, - { - "group": "TActivityResponse", - "pages": [ - "sdks/http/index/TActivityResponse/readme" - ] - }, - { - "group": "TActivityStatus", - "pages": ["sdks/http/index/TActivityStatus/readme"] - }, - { - "group": "TActivityType", - "pages": ["sdks/http/index/TActivityType/readme"] - }, - { - "group": "TERMINAL_ACTIVITY_STATUSES", - "pages": [ - "sdks/http/index/TERMINAL_ACTIVITY_STATUSES/readme" - ] - }, - { - "group": "TSignature", - "pages": ["sdks/http/index/TSignature/readme"] - }, - { - "group": "TSignedRequest", - "pages": ["sdks/http/index/TSignedRequest/readme"] - }, - { - "group": "TurnkeyActivityConsensusNeededError", - "pages": [ - "sdks/http/index/TurnkeyActivityConsensusNeededError/readme" - ] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/http/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/http/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "VERSION", - "pages": ["sdks/http/index/VERSION/readme"] - }, - { - "group": "assertActivityCompleted", - "pages": [ - "sdks/http/index/assertActivityCompleted/readme" - ] - }, - { - "group": "assertNonNull", - "pages": ["sdks/http/index/assertNonNull/readme"] - }, - { - "group": "browserInit", - "pages": ["sdks/http/index/browserInit/readme"] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/http/index/createActivityPoller/readme" - ] - }, - { - "group": "getSignatureFromActivity", - "pages": [ - "sdks/http/index/getSignatureFromActivity/readme" - ] - }, - { - "group": "getSignaturesFromActivity", - "pages": [ - "sdks/http/index/getSignaturesFromActivity/readme" - ] - }, - { - "group": "getSignedTransactionFromActivity", - "pages": [ - "sdks/http/index/getSignedTransactionFromActivity/readme" - ] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/http/index/getWebAuthnAttestation/readme" - ] - }, - { - "group": "init", - "pages": ["sdks/http/index/init/readme"] - }, - "sdks/http/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/http/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "withAsyncPolling", - "pages": ["sdks/http/index/withAsyncPolling/readme"] - } - ] - }, - "sdks/http/readme" - ] - }, - { - "group": "iframe-stamper", - "pages": [ - { - "group": "IframeStamper", - "pages": ["sdks/iframe-stamper/IframeStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "IframeEventType", - "pages": [ - "sdks/iframe-stamper/index/IframeEventType/readme" - ] - }, - { - "group": "IframeStamper", - "pages": [ - "sdks/iframe-stamper/index/IframeStamper/readme" - ] - }, - { - "group": "KeyFormat", - "pages": [ - "sdks/iframe-stamper/index/KeyFormat/readme" - ] - }, - { - "group": "TIframeSettings", - "pages": [ - "sdks/iframe-stamper/index/TIframeSettings/readme" - ] - }, - { - "group": "TIframeStamperConfig", - "pages": [ - "sdks/iframe-stamper/index/TIframeStamperConfig/readme" - ] - }, - { - "group": "TIframeStyles", - "pages": [ - "sdks/iframe-stamper/index/TIframeStyles/readme" - ] - }, - "sdks/iframe-stamper/index/readme" - ] - }, - "sdks/iframe-stamper/readme" - ] - }, - "sdks/modules", - { - "group": "react-native-passkey-stamper", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "AuthenticatorTransport", - "pages": [ - "sdks/react-native-passkey-stamper/index/AuthenticatorTransport/readme" - ] - }, - { - "group": "PasskeyStamper", - "pages": [ - "sdks/react-native-passkey-stamper/index/PasskeyStamper/readme" - ] - }, - { - "group": "PublicKeyCredentialDescriptor", - "pages": [ - "sdks/react-native-passkey-stamper/index/PublicKeyCredentialDescriptor/readme" - ] - }, - { - "group": "TPasskeyRegistrationConfig", - "pages": [ - "sdks/react-native-passkey-stamper/index/TPasskeyRegistrationConfig/readme" - ] - }, - { - "group": "TPasskeyStamperConfig", - "pages": [ - "sdks/react-native-passkey-stamper/index/TPasskeyStamperConfig/readme" - ] - }, - { - "group": "TurnkeyAuthenticatorParams", - "pages": [ - "sdks/react-native-passkey-stamper/index/TurnkeyAuthenticatorParams/readme" - ] - }, - { - "group": "createPasskey", - "pages": [ - "sdks/react-native-passkey-stamper/index/createPasskey/readme" - ] - }, - { - "group": "isSupported", - "pages": [ - "sdks/react-native-passkey-stamper/index/isSupported/readme" - ] - }, - "sdks/react-native-passkey-stamper/index/readme" - ] - }, - "sdks/react-native-passkey-stamper/readme" - ] - }, - "sdks/readme", - { - "group": "sdk-browser", - "pages": [ - { - "group": "JavaScript_Browser", - "pages": ["sdks/sdk-browser/JavaScript_Browser/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": [ - "sdks/sdk-browser/index/ApiKeyStamper/readme" - ] - }, - { - "group": "DEFAULT_APTOS_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_APTOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_COSMOS_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_COSMOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_MAINNET_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_DOGE_MAINNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_TESTNET_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_DOGE_TESTNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_ETHEREUM_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_ETHEREUM_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SEI_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SEI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SOLANA_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SOLANA_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SUI_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SUI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V3R2_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TON_V3R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V4R2_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TON_V4R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TRON_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TRON_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_XLM_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_XLM_ACCOUNTS/readme" - ] - }, - { - "group": "IframeEventType", - "pages": [ - "sdks/sdk-browser/index/IframeEventType/readme" - ] - }, - { - "group": "IframeStamper", - "pages": [ - "sdks/sdk-browser/index/IframeStamper/readme" - ] - }, - { - "group": "StorageKeys", - "pages": [ - "sdks/sdk-browser/index/StorageKeys/readme" - ] - }, - { - "group": "TActivity", - "pages": ["sdks/sdk-browser/index/TActivity/readme"] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "TIframeStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TIframeStamperConfig/readme" - ] - }, - { - "group": "TSignedRequest", - "pages": [ - "sdks/sdk-browser/index/TSignedRequest/readme" - ] - }, - { - "group": "TWebauthnStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TWebauthnStamperConfig/readme" - ] - }, - { - "group": "Turnkey", - "pages": ["sdks/sdk-browser/index/Turnkey/readme"] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/sdk-browser/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyBrowserClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyBrowserClient/readme" - ] - }, - { - "group": "TurnkeyIframeClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyIframeClient/readme" - ] - }, - { - "group": "TurnkeyPasskeyClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyPasskeyClient/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/sdk-browser/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeyWalletClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyWalletClient/readme" - ] - }, - { - "group": "WalletAccount", - "pages": [ - "sdks/sdk-browser/index/WalletAccount/readme" - ] - }, - { - "group": "WebauthnStamper", - "pages": [ - "sdks/sdk-browser/index/WebauthnStamper/readme" - ] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/sdk-browser/index/createActivityPoller/readme" - ] - }, - { - "group": "defaultAptosAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultAptosAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultCosmosAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultCosmosAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeMainnetAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultDogeMainnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeTestnetAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultDogeTestnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultEthereumAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultEthereumAccountAtIndex/readme" - ] - }, - { - "group": "defaultSeiAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSeiAccountAtIndex/readme" - ] - }, - { - "group": "defaultSolanaAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSolanaAccountAtIndex/readme" - ] - }, - { - "group": "defaultSuiAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSuiAccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV3r2AccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTonV3r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV4r2AccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTonV4r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTronAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTronAccountAtIndex/readme" - ] - }, - { - "group": "defaultXlmAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultXlmAccountAtIndex/readme" - ] - }, - { - "group": "defaultXrpAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultXrpAccountAtIndex/readme" - ] - }, - { - "group": "getStorageValue", - "pages": [ - "sdks/sdk-browser/index/getStorageValue/readme" - ] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/sdk-browser/index/getWebAuthnAttestation/readme" - ] - }, - "sdks/sdk-browser/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/sdk-browser/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "setStorageValue", - "pages": [ - "sdks/sdk-browser/index/setStorageValue/readme" - ] - }, - { - "group": "signWithApiKey", - "pages": [ - "sdks/sdk-browser/index/signWithApiKey/readme" - ] - } - ] - }, - "sdks/sdk-browser/readme" - ] - }, - { - "group": "sdk-react", - "pages": [ - { - "group": "React", - "pages": ["sdks/sdk-react/React/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "Auth", - "pages": ["sdks/sdk-react/index/Auth/readme"] - }, - { - "group": "Export", - "pages": ["sdks/sdk-react/index/Export/readme"] - }, - { - "group": "FilterType", - "pages": ["sdks/sdk-react/index/FilterType/readme"] - }, - { - "group": "Import", - "pages": ["sdks/sdk-react/index/Import/readme"] - }, - { - "group": "OtpType", - "pages": ["sdks/sdk-react/index/OtpType/readme"] - }, - { - "group": "OtpVerification", - "pages": [ - "sdks/sdk-react/index/OtpVerification/readme" - ] - }, - { - "group": "TurnkeyContext", - "pages": [ - "sdks/sdk-react/index/TurnkeyContext/readme" - ] - }, - { - "group": "TurnkeyProvider", - "pages": [ - "sdks/sdk-react/index/TurnkeyProvider/readme" - ] - }, - { - "group": "TurnkeyThemeProvider", - "pages": [ - "sdks/sdk-react/index/TurnkeyThemeProvider/readme" - ] - }, - "sdks/sdk-react/index/readme", - { - "group": "useTurnkey", - "pages": ["sdks/sdk-react/index/useTurnkey/readme"] - } - ] - }, - "sdks/sdk-react/readme" - ] - }, - { - "group": "sdk-react-native", - "pages": [ - { - "group": "React_Native", - "pages": ["sdks/sdk-react-native/React_Native/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "AddressFormat", - "pages": [ - "sdks/sdk-react-native/index/AddressFormat/readme" - ] - }, - { - "group": "Curve", - "pages": [ - "sdks/sdk-react-native/index/Curve/readme" - ] - }, - { - "group": "OTP_AUTH_DEFAULT_EXPIRATION_SECONDS", - "pages": [ - "sdks/sdk-react-native/index/OTP_AUTH_DEFAULT_EXPIRATION_SECONDS/readme" - ] - }, - { - "group": "PathFormat", - "pages": [ - "sdks/sdk-react-native/index/PathFormat/readme" - ] - }, - { - "group": "Session", - "pages": [ - "sdks/sdk-react-native/index/Session/readme" - ] - }, - { - "group": "StorageKeys", - "pages": [ - "sdks/sdk-react-native/index/StorageKeys/readme" - ] - }, - { - "group": "Timestamp", - "pages": [ - "sdks/sdk-react-native/index/Timestamp/readme" - ] - }, - { - "group": "TurnkeyConfig", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyConfig/readme" - ] - }, - { - "group": "TurnkeyContext", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyContext/readme" - ] - }, - { - "group": "TurnkeyProvider", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyProvider/readme" - ] - }, - { - "group": "User", - "pages": ["sdks/sdk-react-native/index/User/readme"] - }, - { - "group": "Wallet", - "pages": [ - "sdks/sdk-react-native/index/Wallet/readme" - ] - }, - { - "group": "WalletAccount", - "pages": [ - "sdks/sdk-react-native/index/WalletAccount/readme" - ] - }, - "sdks/sdk-react-native/index/readme", - { - "group": "useTurnkey", - "pages": [ - "sdks/sdk-react-native/index/useTurnkey/readme" - ] - } - ] - }, - "sdks/sdk-react-native/readme" - ] - }, - { - "group": "sdk-server", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/sdk-server/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": [ - "sdks/sdk-server/index/ApiKeyStamper/readme" - ] - }, - { - "group": "DEFAULT_APTOS_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_APTOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_COSMOS_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_COSMOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_MAINNET_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_DOGE_MAINNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_TESTNET_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_DOGE_TESTNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_ETHEREUM_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_ETHEREUM_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SEI_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SEI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SOLANA_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SOLANA_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SUI_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SUI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V3R2_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TON_V3R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V4R2_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TON_V4R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TRON_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TRON_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_XLM_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_XLM_ACCOUNTS/readme" - ] - }, - { - "group": "TActivity", - "pages": ["sdks/sdk-server/index/TActivity/readme"] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/sdk-server/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "TSignedRequest", - "pages": [ - "sdks/sdk-server/index/TSignedRequest/readme" - ] - }, - { - "group": "Turnkey", - "pages": ["sdks/sdk-server/index/Turnkey/readme"] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/sdk-server/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyApiClient", - "pages": [ - "sdks/sdk-server/index/TurnkeyApiClient/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/sdk-server/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeyServerClient", - "pages": [ - "sdks/sdk-server/index/TurnkeyServerClient/readme" - ] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/sdk-server/index/createActivityPoller/readme" - ] - }, - { - "group": "defaultAptosAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultAptosAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultCosmosAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultCosmosAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeMainnetAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultDogeMainnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeTestnetAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultDogeTestnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultEthereumAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultEthereumAccountAtIndex/readme" - ] - }, - { - "group": "defaultSeiAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSeiAccountAtIndex/readme" - ] - }, - { - "group": "defaultSolanaAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSolanaAccountAtIndex/readme" - ] - }, - { - "group": "defaultSuiAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSuiAccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV3r2AccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTonV3r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV4r2AccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTonV4r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTronAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTronAccountAtIndex/readme" - ] - }, - { - "group": "defaultXlmAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultXlmAccountAtIndex/readme" - ] - }, - { - "group": "defaultXrpAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultXrpAccountAtIndex/readme" - ] - }, - { - "group": "fetch", - "pages": ["sdks/sdk-server/index/fetch/readme"] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/sdk-server/index/getWebAuthnAttestation/readme" - ] - }, - "sdks/sdk-server/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/sdk-server/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "server", - "pages": ["sdks/sdk-server/index/server/readme"] - }, - { - "group": "signWithApiKey", - "pages": [ - "sdks/sdk-server/index/signWithApiKey/readme" - ] - } - ] - }, - "sdks/sdk-server/readme" - ] - }, - { - "group": "solana", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/solana/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeySigner", - "pages": ["sdks/solana/index/TurnkeySigner/readme"] - }, - "sdks/solana/index/readme" - ] - }, - "sdks/solana/readme" - ] - }, - { - "group": "telegram-cloud-storage-stamper", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "CloudStorageAPIKey", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/CloudStorageAPIKey/readme" - ] - }, - { - "group": "DEFAULT_TURNKEY_CLOUD_STORAGE_KEY", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/DEFAULT_TURNKEY_CLOUD_STORAGE_KEY/readme" - ] - }, - { - "group": "TTelegramCloudStorageStamperConfig", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/TTelegramCloudStorageStamperConfig/readme" - ] - }, - { - "group": "TelegramCloudStorageStamper", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/TelegramCloudStorageStamper/readme" - ] - }, - "sdks/telegram-cloud-storage-stamper/index/readme" - ] - }, - "sdks/telegram-cloud-storage-stamper/readme" - ] - }, - { - "group": "viem", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/viem/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TTurnkeyActivityErrorType", - "pages": [ - "sdks/viem/index/TTurnkeyActivityErrorType/readme" - ] - }, - { - "group": "TTurnkeyConsensusNeededErrorType", - "pages": [ - "sdks/viem/index/TTurnkeyConsensusNeededErrorType/readme" - ] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/viem/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyConsensusNeededError", - "pages": [ - "sdks/viem/index/TurnkeyConsensusNeededError/readme" - ] - }, - { - "group": "createAccount", - "pages": ["sdks/viem/index/createAccount/readme"] - }, - { - "group": "createAccountWithAddress", - "pages": [ - "sdks/viem/index/createAccountWithAddress/readme" - ] - }, - { - "group": "createApiKeyAccount", - "pages": [ - "sdks/viem/index/createApiKeyAccount/readme" - ] - }, - { - "group": "isTurnkeyActivityConsensusNeededError", - "pages": [ - "sdks/viem/index/isTurnkeyActivityConsensusNeededError/readme" - ] - }, - { - "group": "isTurnkeyActivityError", - "pages": [ - "sdks/viem/index/isTurnkeyActivityError/readme" - ] - }, - "sdks/viem/index/readme", - { - "group": "serializeSignature", - "pages": [ - "sdks/viem/index/serializeSignature/readme" - ] - }, - { - "group": "signMessage", - "pages": ["sdks/viem/index/signMessage/readme"] - }, - { - "group": "signTransaction", - "pages": ["sdks/viem/index/signTransaction/readme"] - }, - { - "group": "signTypedData", - "pages": ["sdks/viem/index/signTypedData/readme"] - } - ] - }, - "sdks/viem/readme" - ] - }, - { - "group": "wallet-stamper", - "pages": [ - { - "group": "WalletStamper", - "pages": ["sdks/wallet-stamper/WalletStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "BaseEthereumWallet", - "pages": [ - "sdks/wallet-stamper/index/BaseEthereumWallet/readme" - ] - }, - { - "group": "BaseWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/BaseWalletInterface/readme" - ] - }, - { - "group": "EthereumWallet", - "pages": [ - "sdks/wallet-stamper/index/EthereumWallet/readme" - ] - }, - { - "group": "EthereumWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/EthereumWalletInterface/readme" - ] - }, - { - "group": "SIGNATURE_SCHEME_TK_API_ED25519", - "pages": [ - "sdks/wallet-stamper/index/SIGNATURE_SCHEME_TK_API_ED25519/readme" - ] - }, - { - "group": "SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191", - "pages": [ - "sdks/wallet-stamper/index/SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191/readme" - ] - }, - { - "group": "STAMP_HEADER_NAME", - "pages": [ - "sdks/wallet-stamper/index/STAMP_HEADER_NAME/readme" - ] - }, - { - "group": "SolanaWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/SolanaWalletInterface/readme" - ] - }, - { - "group": "TStamp", - "pages": ["sdks/wallet-stamper/index/TStamp/readme"] - }, - { - "group": "TStamper", - "pages": [ - "sdks/wallet-stamper/index/TStamper/readme" - ] - }, - { - "group": "WalletInterface", - "pages": [ - "sdks/wallet-stamper/index/WalletInterface/readme" - ] - }, - { - "group": "WalletStamper", - "pages": [ - "sdks/wallet-stamper/index/WalletStamper/readme" - ] - }, - { - "group": "WalletStamperError", - "pages": [ - "sdks/wallet-stamper/index/WalletStamperError/readme" - ] - }, - { - "group": "WalletType", - "pages": [ - "sdks/wallet-stamper/index/WalletType/readme" - ] - }, - { - "group": "getCompressedPublicKey", - "pages": [ - "sdks/wallet-stamper/index/getCompressedPublicKey/readme" - ] - }, - "sdks/wallet-stamper/index/readme" - ] - }, - "sdks/wallet-stamper/readme" - ] - }, - { - "group": "webauthn-stamper", - "pages": [ - { - "group": "WebauthnStamper", - "pages": [ - "sdks/webauthn-stamper/WebauthnStamper/readme" - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TWebauthnStamperConfig", - "pages": [ - "sdks/webauthn-stamper/index/TWebauthnStamperConfig/readme" - ] - }, - { - "group": "WebauthnStamper", - "pages": [ - "sdks/webauthn-stamper/index/WebauthnStamper/readme" - ] - }, - "sdks/webauthn-stamper/index/readme" - ] - }, - "sdks/webauthn-stamper/readme" - ] - } - ] - }, - "sdks/introduction", - "sdks/javascript-browser", - "sdks/javascript-server", - "sdks/react", - "sdks/react-native", - "sdks/golang", - "sdks/rust", - "sdks/Ruby", - "sdks/cli", - "sdks/flutter", - "sdks/swift", - "sdks/swift/proxy-middleware", - "sdks/swift/register-passkey", - "category/web3-libraries", - "sdks/web3/ethers", - "sdks/web3/viem", - "sdks/web3/cosmjs", - "sdks/web3/eip-1193", - "sdks/web3/solana", - "category/advanced", - "sdks/advanced/turnkey-client", - "sdks/advanced/api-key-stamper", - "sdks/advanced/wallet-stamper", - "sdks/advanced/webauthn-stamper", - "sdks/advanced/iframe-stamper", - "sdks/migration-path", - { - "group": "Swift", - "pages": [ - "sdks/swift", - "sdks/swift/proxy-middleware", - "sdks/swift/register-passkey" - ] - }, - { - "group": "Web3 Libraries", - "pages": [ - "category/web3-libraries", - "sdks/web3/ethers", - "sdks/web3/viem", - "sdks/web3/cosmjs", - "sdks/web3/eip-1193", - "sdks/web3/solana" - ] - }, - { - "group": "Advanced", - "pages": [ - "category/advanced", - "sdks/advanced/turnkey-client", - "sdks/advanced/api-key-stamper", - "sdks/advanced/wallet-stamper", - "sdks/advanced/webauthn-stamper", - "sdks/advanced/iframe-stamper" - ] - } - ] - } - ] - }, - { - "tab": "Changelogs", - "pages": [ - { - "group": "Changelogs", - "pages": [ - { - "group": "SDK changelogs", - "pages": [ - "changelogs/api-key-stamper/readme", - "changelogs/cosmjs/readme", - "changelogs/crypto/readme", - "changelogs/eip-1193-provider/readme", - "changelogs/encoding/readme", - "changelogs/ethers/readme", - "changelogs/http/readme", - "changelogs/iframe-stamper/readme", - "changelogs/react-native-passkey-stamper/readme", - "changelogs/sdk-browser/readme", - "changelogs/sdk-react/readme", - "changelogs/sdk-react-native/readme", - "changelogs/sdk-server/readme", - "changelogs/solana/readme", - "changelogs/telegram-cloud-storage-stamper/readme", - "changelogs/viem/readme", - "changelogs/wallet-stamper/readme", - "changelogs/webauthn-stamper/readme", - "changelogs/golang/readme", - "changelogs/dart/readme" - ] - } - ] - } - ] - } - ] - } -} diff --git a/generated-docs/sdk-docs.json b/generated-docs/sdk-docs.json index 041e66707..04776a114 100644 --- a/generated-docs/sdk-docs.json +++ b/generated-docs/sdk-docs.json @@ -1,1954 +1,143 @@ [ { - "group": "SDK Reference", + "group": "core", "pages": [ - { - "group": "sdks", - "pages": [ - { - "group": "_media", - "pages": [] - }, - { - "group": "api-key-stamper", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": ["sdks/api-key-stamper/ApiKeyStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": ["sdks/api-key-stamper/index/ApiKeyStamper/readme"] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/api-key-stamper/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "pointDecode", - "pages": ["sdks/api-key-stamper/index/pointDecode/readme"] - }, - "sdks/api-key-stamper/index/readme", - { - "group": "signWithApiKey", - "pages": [ - "sdks/api-key-stamper/index/signWithApiKey/readme" - ] - } - ] - }, - "sdks/api-key-stamper/readme" - ] - }, - { - "group": "cosmjs", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/cosmjs/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyActivityError", - "pages": ["sdks/cosmjs/index/TurnkeyActivityError/readme"] - }, - { - "group": "TurnkeyDirectWallet", - "pages": ["sdks/cosmjs/index/TurnkeyDirectWallet/readme"] - }, - { - "group": "TurnkeyRequestError", - "pages": ["sdks/cosmjs/index/TurnkeyRequestError/readme"] - }, - { - "group": "fetchCompressedPublicKey", - "pages": [ - "sdks/cosmjs/index/fetchCompressedPublicKey/readme" - ] - }, - "sdks/cosmjs/index/readme" - ] - }, - "sdks/cosmjs/readme" - ] - }, - { - "group": "crypto", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "buildAdditionalAssociatedData", - "pages": [ - "sdks/crypto/index/buildAdditionalAssociatedData/readme" - ] - }, - { - "group": "compressRawPublicKey", - "pages": ["sdks/crypto/index/compressRawPublicKey/readme"] - }, - { - "group": "decryptCredentialBundle", - "pages": [ - "sdks/crypto/index/decryptCredentialBundle/readme" - ] - }, - { - "group": "decryptExportBundle", - "pages": ["sdks/crypto/index/decryptExportBundle/readme"] - }, - { - "group": "encryptPrivateKeyToBundle", - "pages": [ - "sdks/crypto/index/encryptPrivateKeyToBundle/readme" - ] - }, - { - "group": "encryptWalletToBundle", - "pages": ["sdks/crypto/index/encryptWalletToBundle/readme"] - }, - { - "group": "extractPrivateKeyFromPKCS8Bytes", - "pages": [ - "sdks/crypto/index/extractPrivateKeyFromPKCS8Bytes/readme" - ] - }, - { - "group": "formatHpkeBuf", - "pages": ["sdks/crypto/index/formatHpkeBuf/readme"] - }, - { - "group": "fromDerSignature", - "pages": ["sdks/crypto/index/fromDerSignature/readme"] - }, - { - "group": "generateP256KeyPair", - "pages": ["sdks/crypto/index/generateP256KeyPair/readme"] - }, - { - "group": "getPublicKey", - "pages": ["sdks/crypto/index/getPublicKey/readme"] - }, - { - "group": "hpkeAuthEncrypt", - "pages": ["sdks/crypto/index/hpkeAuthEncrypt/readme"] - }, - { - "group": "hpkeDecrypt", - "pages": ["sdks/crypto/index/hpkeDecrypt/readme"] - }, - { - "group": "hpkeEncrypt", - "pages": ["sdks/crypto/index/hpkeEncrypt/readme"] - }, - "sdks/crypto/index/readme", - { - "group": "toDerSignature", - "pages": ["sdks/crypto/index/toDerSignature/readme"] - }, - { - "group": "uncompressRawPublicKey", - "pages": ["sdks/crypto/index/uncompressRawPublicKey/readme"] - }, - { - "group": "verifyStampSignature", - "pages": ["sdks/crypto/index/verifyStampSignature/readme"] - } - ] - }, - "sdks/crypto/readme" - ] - }, - { - "group": "eip-1193-provider", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/eip-1193-provider/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyEIP1193Provider", - "pages": [ - "sdks/eip-1193-provider/index/TurnkeyEIP1193Provider/readme" - ] - }, - { - "group": "createEIP1193Provider", - "pages": [ - "sdks/eip-1193-provider/index/createEIP1193Provider/readme" - ] - }, - "sdks/eip-1193-provider/index/readme" - ] - }, - "sdks/eip-1193-provider/readme" - ] - }, - { - "group": "encoding", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "DEFAULT_JWK_MEMBER_BYTE_LENGTH", - "pages": [ - "sdks/encoding/index/DEFAULT_JWK_MEMBER_BYTE_LENGTH/readme" - ] - }, - { - "group": "base64StringToBase64UrlEncodedString", - "pages": [ - "sdks/encoding/index/base64StringToBase64UrlEncodedString/readme" - ] - }, - { - "group": "hexStringToBase64url", - "pages": ["sdks/encoding/index/hexStringToBase64url/readme"] - }, - { - "group": "hexToAscii", - "pages": ["sdks/encoding/index/hexToAscii/readme"] - }, - { - "group": "normalizePadding", - "pages": ["sdks/encoding/index/normalizePadding/readme"] - }, - "sdks/encoding/index/readme", - { - "group": "stringToBase64urlString", - "pages": [ - "sdks/encoding/index/stringToBase64urlString/readme" - ] - }, - { - "group": "uint8ArrayFromHexString", - "pages": [ - "sdks/encoding/index/uint8ArrayFromHexString/readme" - ] - }, - { - "group": "uint8ArrayToHexString", - "pages": [ - "sdks/encoding/index/uint8ArrayToHexString/readme" - ] - } - ] - }, - "sdks/encoding/readme" - ] - }, - { - "group": "ethers", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/ethers/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeyActivityError", - "pages": ["sdks/ethers/index/TurnkeyActivityError/readme"] - }, - { - "group": "TurnkeyRequestError", - "pages": ["sdks/ethers/index/TurnkeyRequestError/readme"] - }, - { - "group": "TurnkeySigner", - "pages": ["sdks/ethers/index/TurnkeySigner/readme"] - }, - "sdks/ethers/index/readme", - { - "group": "serializeSignature", - "pages": ["sdks/ethers/index/serializeSignature/readme"] - } - ] - }, - "sdks/ethers/readme" - ] - }, - { - "group": "http", - "pages": [ - { - "group": "TurnkeyClient", - "pages": ["sdks/http/TurnkeyClient/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "InvalidArgumentError", - "pages": ["sdks/http/index/InvalidArgumentError/readme"] - }, - { - "group": "SignedRequest", - "pages": ["sdks/http/index/SignedRequest/readme"] - }, - { - "group": "TActivity", - "pages": ["sdks/http/index/TActivity/readme"] - }, - { - "group": "TActivityId", - "pages": ["sdks/http/index/TActivityId/readme"] - }, - { - "group": "TActivityResponse", - "pages": ["sdks/http/index/TActivityResponse/readme"] - }, - { - "group": "TActivityStatus", - "pages": ["sdks/http/index/TActivityStatus/readme"] - }, - { - "group": "TActivityType", - "pages": ["sdks/http/index/TActivityType/readme"] - }, - { - "group": "TERMINAL_ACTIVITY_STATUSES", - "pages": [ - "sdks/http/index/TERMINAL_ACTIVITY_STATUSES/readme" - ] - }, - { - "group": "TSignature", - "pages": ["sdks/http/index/TSignature/readme"] - }, - { - "group": "TSignedRequest", - "pages": ["sdks/http/index/TSignedRequest/readme"] - }, - { - "group": "TurnkeyActivityConsensusNeededError", - "pages": [ - "sdks/http/index/TurnkeyActivityConsensusNeededError/readme" - ] - }, - { - "group": "TurnkeyActivityError", - "pages": ["sdks/http/index/TurnkeyActivityError/readme"] - }, - { - "group": "TurnkeyRequestError", - "pages": ["sdks/http/index/TurnkeyRequestError/readme"] - }, - { - "group": "VERSION", - "pages": ["sdks/http/index/VERSION/readme"] - }, - { - "group": "assertActivityCompleted", - "pages": ["sdks/http/index/assertActivityCompleted/readme"] - }, - { - "group": "assertNonNull", - "pages": ["sdks/http/index/assertNonNull/readme"] - }, - { - "group": "browserInit", - "pages": ["sdks/http/index/browserInit/readme"] - }, - { - "group": "createActivityPoller", - "pages": ["sdks/http/index/createActivityPoller/readme"] - }, - { - "group": "getSignatureFromActivity", - "pages": ["sdks/http/index/getSignatureFromActivity/readme"] - }, - { - "group": "getSignaturesFromActivity", - "pages": [ - "sdks/http/index/getSignaturesFromActivity/readme" - ] - }, - { - "group": "getSignedTransactionFromActivity", - "pages": [ - "sdks/http/index/getSignedTransactionFromActivity/readme" - ] - }, - { - "group": "getWebAuthnAttestation", - "pages": ["sdks/http/index/getWebAuthnAttestation/readme"] - }, - { - "group": "init", - "pages": ["sdks/http/index/init/readme"] - }, - "sdks/http/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": ["sdks/http/index/sealAndStampRequestBody/readme"] - }, - { - "group": "withAsyncPolling", - "pages": ["sdks/http/index/withAsyncPolling/readme"] - } - ] - }, - "sdks/http/readme" - ] - }, - { - "group": "iframe-stamper", - "pages": [ - { - "group": "IframeStamper", - "pages": ["sdks/iframe-stamper/IframeStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "IframeEventType", - "pages": [ - "sdks/iframe-stamper/index/IframeEventType/readme" - ] - }, - { - "group": "IframeStamper", - "pages": ["sdks/iframe-stamper/index/IframeStamper/readme"] - }, - { - "group": "KeyFormat", - "pages": ["sdks/iframe-stamper/index/KeyFormat/readme"] - }, - { - "group": "TIframeSettings", - "pages": [ - "sdks/iframe-stamper/index/TIframeSettings/readme" - ] - }, - { - "group": "TIframeStamperConfig", - "pages": [ - "sdks/iframe-stamper/index/TIframeStamperConfig/readme" - ] - }, - { - "group": "TIframeStyles", - "pages": ["sdks/iframe-stamper/index/TIframeStyles/readme"] - }, - "sdks/iframe-stamper/index/readme" - ] - }, - "sdks/iframe-stamper/readme" - ] - }, - "sdks/modules", - { - "group": "react-native-passkey-stamper", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "AuthenticatorTransport", - "pages": [ - "sdks/react-native-passkey-stamper/index/AuthenticatorTransport/readme" - ] - }, - { - "group": "PasskeyStamper", - "pages": [ - "sdks/react-native-passkey-stamper/index/PasskeyStamper/readme" - ] - }, - { - "group": "PublicKeyCredentialDescriptor", - "pages": [ - "sdks/react-native-passkey-stamper/index/PublicKeyCredentialDescriptor/readme" - ] - }, - { - "group": "TPasskeyRegistrationConfig", - "pages": [ - "sdks/react-native-passkey-stamper/index/TPasskeyRegistrationConfig/readme" - ] - }, - { - "group": "TPasskeyStamperConfig", - "pages": [ - "sdks/react-native-passkey-stamper/index/TPasskeyStamperConfig/readme" - ] - }, - { - "group": "TurnkeyAuthenticatorParams", - "pages": [ - "sdks/react-native-passkey-stamper/index/TurnkeyAuthenticatorParams/readme" - ] - }, - { - "group": "createPasskey", - "pages": [ - "sdks/react-native-passkey-stamper/index/createPasskey/readme" - ] - }, - { - "group": "isSupported", - "pages": [ - "sdks/react-native-passkey-stamper/index/isSupported/readme" - ] - }, - "sdks/react-native-passkey-stamper/index/readme" - ] - }, - "sdks/react-native-passkey-stamper/readme" - ] - }, - "sdks/readme", - { - "group": "sdk-browser", - "pages": [ - { - "group": "JavaScript_Browser", - "pages": ["sdks/sdk-browser/JavaScript_Browser/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": ["sdks/sdk-browser/index/ApiKeyStamper/readme"] - }, - { - "group": "DEFAULT_APTOS_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_APTOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_COSMOS_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_COSMOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_MAINNET_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_DOGE_MAINNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_TESTNET_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_DOGE_TESTNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_ETHEREUM_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_ETHEREUM_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SEI_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SEI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SOLANA_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SOLANA_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SUI_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_SUI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V3R2_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TON_V3R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V4R2_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TON_V4R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TRON_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_TRON_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_XLM_ACCOUNTS", - "pages": [ - "sdks/sdk-browser/index/DEFAULT_XLM_ACCOUNTS/readme" - ] - }, - { - "group": "IframeEventType", - "pages": ["sdks/sdk-browser/index/IframeEventType/readme"] - }, - { - "group": "IframeStamper", - "pages": ["sdks/sdk-browser/index/IframeStamper/readme"] - }, - { - "group": "StorageKeys", - "pages": ["sdks/sdk-browser/index/StorageKeys/readme"] - }, - { - "group": "TActivity", - "pages": ["sdks/sdk-browser/index/TActivity/readme"] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "TIframeStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TIframeStamperConfig/readme" - ] - }, - { - "group": "TSignedRequest", - "pages": ["sdks/sdk-browser/index/TSignedRequest/readme"] - }, - { - "group": "TWebauthnStamperConfig", - "pages": [ - "sdks/sdk-browser/index/TWebauthnStamperConfig/readme" - ] - }, - { - "group": "Turnkey", - "pages": ["sdks/sdk-browser/index/Turnkey/readme"] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/sdk-browser/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyBrowserClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyBrowserClient/readme" - ] - }, - { - "group": "TurnkeyIframeClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyIframeClient/readme" - ] - }, - { - "group": "TurnkeyPasskeyClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyPasskeyClient/readme" - ] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/sdk-browser/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeyWalletClient", - "pages": [ - "sdks/sdk-browser/index/TurnkeyWalletClient/readme" - ] - }, - { - "group": "WalletAccount", - "pages": ["sdks/sdk-browser/index/WalletAccount/readme"] - }, - { - "group": "WebauthnStamper", - "pages": ["sdks/sdk-browser/index/WebauthnStamper/readme"] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/sdk-browser/index/createActivityPoller/readme" - ] - }, - { - "group": "defaultAptosAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultAptosAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinMainnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinRegtestP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinSignetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultBitcoinTestnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultCosmosAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultCosmosAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeMainnetAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultDogeMainnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeTestnetAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultDogeTestnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultEthereumAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultEthereumAccountAtIndex/readme" - ] - }, - { - "group": "defaultSeiAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSeiAccountAtIndex/readme" - ] - }, - { - "group": "defaultSolanaAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSolanaAccountAtIndex/readme" - ] - }, - { - "group": "defaultSuiAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultSuiAccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV3r2AccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTonV3r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV4r2AccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTonV4r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTronAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultTronAccountAtIndex/readme" - ] - }, - { - "group": "defaultXlmAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultXlmAccountAtIndex/readme" - ] - }, - { - "group": "defaultXrpAccountAtIndex", - "pages": [ - "sdks/sdk-browser/index/defaultXrpAccountAtIndex/readme" - ] - }, - { - "group": "getStorageValue", - "pages": ["sdks/sdk-browser/index/getStorageValue/readme"] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/sdk-browser/index/getWebAuthnAttestation/readme" - ] - }, - "sdks/sdk-browser/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/sdk-browser/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "setStorageValue", - "pages": ["sdks/sdk-browser/index/setStorageValue/readme"] - }, - { - "group": "signWithApiKey", - "pages": ["sdks/sdk-browser/index/signWithApiKey/readme"] - } - ] - }, - "sdks/sdk-browser/readme" - ] - }, - { - "group": "sdk-react", - "pages": [ - { - "group": "React", - "pages": ["sdks/sdk-react/React/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "Auth", - "pages": ["sdks/sdk-react/index/Auth/readme"] - }, - { - "group": "Export", - "pages": ["sdks/sdk-react/index/Export/readme"] - }, - { - "group": "FilterType", - "pages": ["sdks/sdk-react/index/FilterType/readme"] - }, - { - "group": "Import", - "pages": ["sdks/sdk-react/index/Import/readme"] - }, - { - "group": "OtpType", - "pages": ["sdks/sdk-react/index/OtpType/readme"] - }, - { - "group": "OtpVerification", - "pages": ["sdks/sdk-react/index/OtpVerification/readme"] - }, - { - "group": "TurnkeyContext", - "pages": ["sdks/sdk-react/index/TurnkeyContext/readme"] - }, - { - "group": "TurnkeyProvider", - "pages": ["sdks/sdk-react/index/TurnkeyProvider/readme"] - }, - { - "group": "TurnkeyThemeProvider", - "pages": [ - "sdks/sdk-react/index/TurnkeyThemeProvider/readme" - ] - }, - "sdks/sdk-react/index/readme", - { - "group": "useTurnkey", - "pages": ["sdks/sdk-react/index/useTurnkey/readme"] - } - ] - }, - "sdks/sdk-react/readme" - ] - }, - { - "group": "sdk-react-native", - "pages": [ - { - "group": "React_Native", - "pages": ["sdks/sdk-react-native/React_Native/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "AddressFormat", - "pages": [ - "sdks/sdk-react-native/index/AddressFormat/readme" - ] - }, - { - "group": "Curve", - "pages": ["sdks/sdk-react-native/index/Curve/readme"] - }, - { - "group": "OTP_AUTH_DEFAULT_EXPIRATION_SECONDS", - "pages": [ - "sdks/sdk-react-native/index/OTP_AUTH_DEFAULT_EXPIRATION_SECONDS/readme" - ] - }, - { - "group": "PathFormat", - "pages": ["sdks/sdk-react-native/index/PathFormat/readme"] - }, - { - "group": "Session", - "pages": ["sdks/sdk-react-native/index/Session/readme"] - }, - { - "group": "StorageKeys", - "pages": ["sdks/sdk-react-native/index/StorageKeys/readme"] - }, - { - "group": "Timestamp", - "pages": ["sdks/sdk-react-native/index/Timestamp/readme"] - }, - { - "group": "TurnkeyConfig", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyConfig/readme" - ] - }, - { - "group": "TurnkeyContext", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyContext/readme" - ] - }, - { - "group": "TurnkeyProvider", - "pages": [ - "sdks/sdk-react-native/index/TurnkeyProvider/readme" - ] - }, - { - "group": "User", - "pages": ["sdks/sdk-react-native/index/User/readme"] - }, - { - "group": "Wallet", - "pages": ["sdks/sdk-react-native/index/Wallet/readme"] - }, - { - "group": "WalletAccount", - "pages": [ - "sdks/sdk-react-native/index/WalletAccount/readme" - ] - }, - "sdks/sdk-react-native/index/readme", - { - "group": "useTurnkey", - "pages": ["sdks/sdk-react-native/index/useTurnkey/readme"] - } - ] - }, - "sdks/sdk-react-native/readme" - ] - }, - { - "group": "sdk-server", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/sdk-server/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "ApiKeyStamper", - "pages": ["sdks/sdk-server/index/ApiKeyStamper/readme"] - }, - { - "group": "DEFAULT_APTOS_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_APTOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_MAINNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_REGTEST_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_SIGNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2PKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2SH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2TR_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2WPKH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_BITCOIN_TESTNET_P2WSH_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_COSMOS_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_COSMOS_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_MAINNET_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_DOGE_MAINNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_DOGE_TESTNET_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_DOGE_TESTNET_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_ETHEREUM_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_ETHEREUM_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SEI_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SEI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SOLANA_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SOLANA_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_SUI_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_SUI_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V3R2_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TON_V3R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TON_V4R2_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TON_V4R2_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_TRON_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_TRON_ACCOUNTS/readme" - ] - }, - { - "group": "DEFAULT_XLM_ACCOUNTS", - "pages": [ - "sdks/sdk-server/index/DEFAULT_XLM_ACCOUNTS/readme" - ] - }, - { - "group": "TActivity", - "pages": ["sdks/sdk-server/index/TActivity/readme"] - }, - { - "group": "TApiKeyStamperConfig", - "pages": [ - "sdks/sdk-server/index/TApiKeyStamperConfig/readme" - ] - }, - { - "group": "TSignedRequest", - "pages": ["sdks/sdk-server/index/TSignedRequest/readme"] - }, - { - "group": "Turnkey", - "pages": ["sdks/sdk-server/index/Turnkey/readme"] - }, - { - "group": "TurnkeyActivityError", - "pages": [ - "sdks/sdk-server/index/TurnkeyActivityError/readme" - ] - }, - { - "group": "TurnkeyApiClient", - "pages": ["sdks/sdk-server/index/TurnkeyApiClient/readme"] - }, - { - "group": "TurnkeyRequestError", - "pages": [ - "sdks/sdk-server/index/TurnkeyRequestError/readme" - ] - }, - { - "group": "TurnkeyServerClient", - "pages": [ - "sdks/sdk-server/index/TurnkeyServerClient/readme" - ] - }, - { - "group": "createActivityPoller", - "pages": [ - "sdks/sdk-server/index/createActivityPoller/readme" - ] - }, - { - "group": "defaultAptosAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultAptosAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinMainnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinMainnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinRegtestP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinRegtestP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinSignetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinSignetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2PKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2PKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2SHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2SHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2TRAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2TRAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WPKHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2WPKHAccountAtIndex/readme" - ] - }, - { - "group": "defaultBitcoinTestnetP2WSHAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultBitcoinTestnetP2WSHAccountAtIndex/readme" - ] - }, - { - "group": "defaultCosmosAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultCosmosAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeMainnetAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultDogeMainnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultDogeTestnetAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultDogeTestnetAccountAtIndex/readme" - ] - }, - { - "group": "defaultEthereumAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultEthereumAccountAtIndex/readme" - ] - }, - { - "group": "defaultSeiAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSeiAccountAtIndex/readme" - ] - }, - { - "group": "defaultSolanaAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSolanaAccountAtIndex/readme" - ] - }, - { - "group": "defaultSuiAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultSuiAccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV3r2AccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTonV3r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTonV4r2AccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTonV4r2AccountAtIndex/readme" - ] - }, - { - "group": "defaultTronAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultTronAccountAtIndex/readme" - ] - }, - { - "group": "defaultXlmAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultXlmAccountAtIndex/readme" - ] - }, - { - "group": "defaultXrpAccountAtIndex", - "pages": [ - "sdks/sdk-server/index/defaultXrpAccountAtIndex/readme" - ] - }, - { - "group": "fetch", - "pages": ["sdks/sdk-server/index/fetch/readme"] - }, - { - "group": "getWebAuthnAttestation", - "pages": [ - "sdks/sdk-server/index/getWebAuthnAttestation/readme" - ] - }, - "sdks/sdk-server/index/readme", - { - "group": "sealAndStampRequestBody", - "pages": [ - "sdks/sdk-server/index/sealAndStampRequestBody/readme" - ] - }, - { - "group": "server", - "pages": ["sdks/sdk-server/index/server/readme"] - }, - { - "group": "signWithApiKey", - "pages": ["sdks/sdk-server/index/signWithApiKey/readme"] - } - ] - }, - "sdks/sdk-server/readme" - ] - }, - { - "group": "solana", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/solana/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TurnkeySigner", - "pages": ["sdks/solana/index/TurnkeySigner/readme"] - }, - "sdks/solana/index/readme" - ] - }, - "sdks/solana/readme" - ] - }, - { - "group": "telegram-cloud-storage-stamper", - "pages": [ - { - "group": "index", - "pages": [ - { - "group": "CloudStorageAPIKey", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/CloudStorageAPIKey/readme" - ] - }, - { - "group": "DEFAULT_TURNKEY_CLOUD_STORAGE_KEY", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/DEFAULT_TURNKEY_CLOUD_STORAGE_KEY/readme" - ] - }, - { - "group": "TTelegramCloudStorageStamperConfig", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/TTelegramCloudStorageStamperConfig/readme" - ] - }, - { - "group": "TelegramCloudStorageStamper", - "pages": [ - "sdks/telegram-cloud-storage-stamper/index/TelegramCloudStorageStamper/readme" - ] - }, - "sdks/telegram-cloud-storage-stamper/index/readme" - ] - }, - "sdks/telegram-cloud-storage-stamper/readme" - ] - }, - { - "group": "viem", - "pages": [ - { - "group": "documents", - "pages": [ - { - "group": "docs", - "pages": ["sdks/viem/documents/docs/readme"] - } - ] - }, - { - "group": "index", - "pages": [ - { - "group": "TTurnkeyActivityErrorType", - "pages": [ - "sdks/viem/index/TTurnkeyActivityErrorType/readme" - ] - }, - { - "group": "TTurnkeyConsensusNeededErrorType", - "pages": [ - "sdks/viem/index/TTurnkeyConsensusNeededErrorType/readme" - ] - }, - { - "group": "TurnkeyActivityError", - "pages": ["sdks/viem/index/TurnkeyActivityError/readme"] - }, - { - "group": "TurnkeyConsensusNeededError", - "pages": [ - "sdks/viem/index/TurnkeyConsensusNeededError/readme" - ] - }, - { - "group": "createAccount", - "pages": ["sdks/viem/index/createAccount/readme"] - }, - { - "group": "createAccountWithAddress", - "pages": ["sdks/viem/index/createAccountWithAddress/readme"] - }, - { - "group": "createApiKeyAccount", - "pages": ["sdks/viem/index/createApiKeyAccount/readme"] - }, - { - "group": "isTurnkeyActivityConsensusNeededError", - "pages": [ - "sdks/viem/index/isTurnkeyActivityConsensusNeededError/readme" - ] - }, - { - "group": "isTurnkeyActivityError", - "pages": ["sdks/viem/index/isTurnkeyActivityError/readme"] - }, - "sdks/viem/index/readme", - { - "group": "serializeSignature", - "pages": ["sdks/viem/index/serializeSignature/readme"] - }, - { - "group": "signMessage", - "pages": ["sdks/viem/index/signMessage/readme"] - }, - { - "group": "signTransaction", - "pages": ["sdks/viem/index/signTransaction/readme"] - }, - { - "group": "signTypedData", - "pages": ["sdks/viem/index/signTypedData/readme"] - } - ] - }, - "sdks/viem/readme" - ] - }, - { - "group": "wallet-stamper", - "pages": [ - { - "group": "WalletStamper", - "pages": ["sdks/wallet-stamper/WalletStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "BaseEthereumWallet", - "pages": [ - "sdks/wallet-stamper/index/BaseEthereumWallet/readme" - ] - }, - { - "group": "BaseWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/BaseWalletInterface/readme" - ] - }, - { - "group": "EthereumWallet", - "pages": ["sdks/wallet-stamper/index/EthereumWallet/readme"] - }, - { - "group": "EthereumWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/EthereumWalletInterface/readme" - ] - }, - { - "group": "SIGNATURE_SCHEME_TK_API_ED25519", - "pages": [ - "sdks/wallet-stamper/index/SIGNATURE_SCHEME_TK_API_ED25519/readme" - ] - }, - { - "group": "SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191", - "pages": [ - "sdks/wallet-stamper/index/SIGNATURE_SCHEME_TK_API_SECP256K1_EIP191/readme" - ] - }, - { - "group": "STAMP_HEADER_NAME", - "pages": [ - "sdks/wallet-stamper/index/STAMP_HEADER_NAME/readme" - ] - }, - { - "group": "SolanaWalletInterface", - "pages": [ - "sdks/wallet-stamper/index/SolanaWalletInterface/readme" - ] - }, - { - "group": "TStamp", - "pages": ["sdks/wallet-stamper/index/TStamp/readme"] - }, - { - "group": "TStamper", - "pages": ["sdks/wallet-stamper/index/TStamper/readme"] - }, - { - "group": "WalletInterface", - "pages": [ - "sdks/wallet-stamper/index/WalletInterface/readme" - ] - }, - { - "group": "WalletStamper", - "pages": ["sdks/wallet-stamper/index/WalletStamper/readme"] - }, - { - "group": "WalletStamperError", - "pages": [ - "sdks/wallet-stamper/index/WalletStamperError/readme" - ] - }, - { - "group": "WalletType", - "pages": ["sdks/wallet-stamper/index/WalletType/readme"] - }, - { - "group": "getCompressedPublicKey", - "pages": [ - "sdks/wallet-stamper/index/getCompressedPublicKey/readme" - ] - }, - "sdks/wallet-stamper/index/readme" - ] - }, - "sdks/wallet-stamper/readme" - ] - }, - { - "group": "webauthn-stamper", - "pages": [ - { - "group": "WebauthnStamper", - "pages": ["sdks/webauthn-stamper/WebauthnStamper/readme"] - }, - { - "group": "index", - "pages": [ - { - "group": "TWebauthnStamperConfig", - "pages": [ - "sdks/webauthn-stamper/index/TWebauthnStamperConfig/readme" - ] - }, - { - "group": "WebauthnStamper", - "pages": [ - "sdks/webauthn-stamper/index/WebauthnStamper/readme" - ] - }, - "sdks/webauthn-stamper/index/readme" - ] - }, - "sdks/webauthn-stamper/readme" - ] - } - ] - } + "generated-docs/formatted/core/turnkey-client-add-oauth-provider", + "generated-docs/formatted/core/turnkey-client-add-passkey", + "generated-docs/formatted/core/turnkey-client-clear-all-sessions", + "generated-docs/formatted/core/turnkey-client-clear-session", + "generated-docs/formatted/core/turnkey-client-clear-unused-key-pairs", + "generated-docs/formatted/core/turnkey-client-complete-oauth", + "generated-docs/formatted/core/turnkey-client-complete-otp", + "generated-docs/formatted/core/turnkey-client-connect-wallet-account", + "generated-docs/formatted/core/turnkey-client-constructor", + "generated-docs/formatted/core/turnkey-client-create-api-key-pair", + "generated-docs/formatted/core/turnkey-client-create-passkey", + "generated-docs/formatted/core/turnkey-client-create-wallet", + "generated-docs/formatted/core/turnkey-client-create-wallet-accounts", + "generated-docs/formatted/core/turnkey-client-delete-sub-organization", + "generated-docs/formatted/core/turnkey-client-disconnect-wallet-account", + "generated-docs/formatted/core/turnkey-client-export-private-key", + "generated-docs/formatted/core/turnkey-client-export-wallet", + "generated-docs/formatted/core/turnkey-client-export-wallet-account", + "generated-docs/formatted/core/turnkey-client-fetch-user", + "generated-docs/formatted/core/turnkey-client-fetch-wallet-accounts", + "generated-docs/formatted/core/turnkey-client-fetch-wallets", + "generated-docs/formatted/core/turnkey-client-get-active-session-key", + "generated-docs/formatted/core/turnkey-client-get-all-sessions", + "generated-docs/formatted/core/turnkey-client-get-proxy-auth-config", + "generated-docs/formatted/core/turnkey-client-get-session", + "generated-docs/formatted/core/turnkey-client-get-wallet-providers", + "generated-docs/formatted/core/turnkey-client-import-private-key", + "generated-docs/formatted/core/turnkey-client-import-wallet", + "generated-docs/formatted/core/turnkey-client-init", + "generated-docs/formatted/core/turnkey-client-init-otp", + "generated-docs/formatted/core/turnkey-client-login-or-signup-with-wallet", + "generated-docs/formatted/core/turnkey-client-login-with-oauth", + "generated-docs/formatted/core/turnkey-client-login-with-otp", + "generated-docs/formatted/core/turnkey-client-login-with-passkey", + "generated-docs/formatted/core/turnkey-client-login-with-wallet", + "generated-docs/formatted/core/turnkey-client-logout", + "generated-docs/formatted/core/turnkey-client-refresh-session", + "generated-docs/formatted/core/turnkey-client-remove-oauth-providers", + "generated-docs/formatted/core/turnkey-client-remove-passkeys", + "generated-docs/formatted/core/turnkey-client-remove-user-email", + "generated-docs/formatted/core/turnkey-client-remove-user-phone-number", + "generated-docs/formatted/core/turnkey-client-set-active-session", + "generated-docs/formatted/core/turnkey-client-sign-and-send-transaction", + "generated-docs/formatted/core/turnkey-client-sign-message", + "generated-docs/formatted/core/turnkey-client-sign-transaction", + "generated-docs/formatted/core/turnkey-client-sign-up-with-oauth", + "generated-docs/formatted/core/turnkey-client-sign-up-with-otp", + "generated-docs/formatted/core/turnkey-client-sign-up-with-passkey", + "generated-docs/formatted/core/turnkey-client-sign-up-with-wallet", + "generated-docs/formatted/core/turnkey-client-store-session", + "generated-docs/formatted/core/turnkey-client-switch-wallet-account-chain", + "generated-docs/formatted/core/turnkey-client-update-user-email", + "generated-docs/formatted/core/turnkey-client-update-user-name", + "generated-docs/formatted/core/turnkey-client-update-user-phone-number", + "generated-docs/formatted/core/turnkey-client-verify-otp" + ] + }, + { + "group": "react-wallet-kit", + "pages": [ + "generated-docs/formatted/react-wallet-kit/client-context-type-add-oauth-provider", + "generated-docs/formatted/react-wallet-kit/client-context-type-add-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-clear-all-sessions", + "generated-docs/formatted/react-wallet-kit/client-context-type-clear-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-clear-unused-key-pairs", + "generated-docs/formatted/react-wallet-kit/client-context-type-complete-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-complete-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-connect-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-api-key-pair", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-create-wallet-accounts", + "generated-docs/formatted/react-wallet-kit/client-context-type-delete-sub-organization", + "generated-docs/formatted/react-wallet-kit/client-context-type-disconnect-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-export-private-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-export-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-fetch-user", + "generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallet-accounts", + "generated-docs/formatted/react-wallet-kit/client-context-type-fetch-wallets", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-active-session-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-all-sessions", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-proxy-auth-config", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-get-wallet-providers", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-oauth-provider", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-add-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-apple-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-private-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-export-wallet-account", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-facebook-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-google-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-import-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-link-external-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-login", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-oauth-provider", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-remove-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-sign-message", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-name", + "generated-docs/formatted/react-wallet-kit/client-context-type-handle-update-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-import-private-key", + "generated-docs/formatted/react-wallet-kit/client-context-type-import-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-init-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-or-signup-with-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-login-with-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-logout", + "generated-docs/formatted/react-wallet-kit/client-context-type-refresh-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-refresh-user", + "generated-docs/formatted/react-wallet-kit/client-context-type-refresh-wallets", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-oauth-providers", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-passkeys", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-remove-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-set-active-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-and-send-transaction", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-message", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-transaction", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-oauth", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-otp", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-passkey", + "generated-docs/formatted/react-wallet-kit/client-context-type-sign-up-with-wallet", + "generated-docs/formatted/react-wallet-kit/client-context-type-store-session", + "generated-docs/formatted/react-wallet-kit/client-context-type-switch-wallet-account-chain", + "generated-docs/formatted/react-wallet-kit/client-context-type-update-user-email", + "generated-docs/formatted/react-wallet-kit/client-context-type-update-user-name", + "generated-docs/formatted/react-wallet-kit/client-context-type-update-user-phone-number", + "generated-docs/formatted/react-wallet-kit/client-context-type-verify-otp" ] } ] diff --git a/generated-docs/sdks/_media/LICENSE b/generated-docs/sdks/_media/LICENSE deleted file mode 100644 index dc831362d..000000000 --- a/generated-docs/sdks/_media/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - -Copyright 2024 Turnkey - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/generated-docs/sdks/_media/LICENSE-1 b/generated-docs/sdks/_media/LICENSE-1 deleted file mode 100644 index dc831362d..000000000 --- a/generated-docs/sdks/_media/LICENSE-1 +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - -TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - -1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - -2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - -3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - -4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - -5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - -6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - -7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - -8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - -9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - -END OF TERMS AND CONDITIONS - -APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - -Copyright 2024 Turnkey - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. diff --git a/generated-docs/sdks/_media/demo-passkey-wallet.png b/generated-docs/sdks/_media/demo-passkey-wallet.png deleted file mode 100644 index fd29cca7f..000000000 Binary files a/generated-docs/sdks/_media/demo-passkey-wallet.png and /dev/null differ diff --git a/generated-docs/sdks/_media/ethers-ui-screenshot.png b/generated-docs/sdks/_media/ethers-ui-screenshot.png deleted file mode 100644 index eca09be85..000000000 Binary files a/generated-docs/sdks/_media/ethers-ui-screenshot.png and /dev/null differ diff --git a/generated-docs/sdks/_media/sdk-map.png b/generated-docs/sdks/_media/sdk-map.png deleted file mode 100644 index 4097c9bc1..000000000 Binary files a/generated-docs/sdks/_media/sdk-map.png and /dev/null differ diff --git a/generated-docs/sdks/_media/sdk-web-diagram.png b/generated-docs/sdks/_media/sdk-web-diagram.png deleted file mode 100644 index ec9a002e5..000000000 Binary files a/generated-docs/sdks/_media/sdk-web-diagram.png and /dev/null differ diff --git a/generated-docs/sdks/_media/viem-ui-screenshot.png b/generated-docs/sdks/_media/viem-ui-screenshot.png deleted file mode 100644 index 4c54d5ee5..000000000 Binary files a/generated-docs/sdks/_media/viem-ui-screenshot.png and /dev/null differ diff --git a/generated-docs/sdks/api-key-stamper/ApiKeyStamper/readme.mdx b/generated-docs/sdks/api-key-stamper/ApiKeyStamper/readme.mdx deleted file mode 100644 index 35301ee59..000000000 --- a/generated-docs/sdks/api-key-stamper/ApiKeyStamper/readme.mdx +++ /dev/null @@ -1,137 +0,0 @@ ---- -title: "ApiKeyStamper" -mode: wide ---- - -## Introduction - -The [`@turnkey/api-key-stamper`](https://www.npmjs.com/package/@turnkey/api-key-stamper) package simplifies the process of using your public/private API keys and passkeys to stamp and approve activity requests for Turnkey's API. This stamping mechanism is central to the API's security, ensuring that each request is authenticated and authorized. For an in-depth understanding of API keys see [this section](/faq#why-do-you-require-a-public--private-key-pair-to-access-turnkey-api). - -## Installing - -To get started install the [`@turnkey/api-key-stamper`](https://www.npmjs.com/package/@turnkey/api-key-stamper) client. - - - -```bash npm -pnpm i @turnkey/api-key-stamper -``` - -```bash pnpm -pnpm i @turnkey/api-key-stamper -``` - -```bash yarn -yarn add @turnkey/api-key-stamper -``` - - - -## Initializing - -The `ApiKeyStamper` class implements the `TStamper` interface used by the [TurnkeyClient](/sdks/advanced/turnkey-client) in the `@turnkey/http` module. It encapsulates the logic necessary to sign activity requests and generates the appropriate HTTP headers for authentication. To get started with an `ApiKeyStamper`, you can initialize it using its constructor: - -### `constructor(config: TApiKeyStamperConfig): TStamper` - - - -An object containing configuration settings for the stamper. - - - - -Your Turnkey API private key. - - - - -Your Turnkey API public key. - - -### Types - -#### `TApiKeyStamperConfig` - -```js -type TApiKeyStamperConfig = { - apiPublicKey: string; - apiPrivateKey: string; -}; -``` - -#### `TStamper` - -```js -interface TStamper { - stamp: (input: string) => Promise; -}; -``` - -#### Example - -The example below shows how to initialize and use the `ApiKeyStamper` with the `TurnkeyClient` to make a request to Turnkey's [`/public/v1/query/whoami`](/api-reference/sessions/who-am-i) endpoint: - -```js -import { TurnkeyClient } from "@turnkey/http"; -import { ApiKeyStamper } from "@turnkey/api-key-stamper"; - -// Following best practices, define parameters in your .env file -const baseUrl = process.env.TURNKEY_BASE_URL || "https://api.turnkey.com"; -const apiPublicKey = process.env.TURNKEY_API_PUBLIC_KEY; -const apiPrivateKey = process.env.TURNKEY_API_PRIVATE_KEY; - -// Initialize the API key stamper -const stamper = new ApiKeyStamper({ apiPublicKey, apiPrivateKey }); - -// Initialize the Turnkey client -const tk = new TurnkeyClient({ baseUrl }, stamper); - -// Now you can make authenticated requests using the APIKeyStamper -const whoami = await tk.getWhoami({ - organizationId: "", -}); -``` - -## Methods - -### `stamp: (input: string) => Promise` - -Creates a digital stamp which includes the public key, signature scheme, and a signature. - -#### Parameters - - - -The payload that needs to be stamped. - - -#### Types - -##### `TStamp` - -```js -type TStamp = { - stampHeaderName: string; - stampHeaderValue: string; -}; -``` diff --git a/generated-docs/sdks/api-key-stamper/index/ApiKeyStamper/readme.mdx b/generated-docs/sdks/api-key-stamper/index/ApiKeyStamper/readme.mdx deleted file mode 100644 index 8509b80a4..000000000 --- a/generated-docs/sdks/api-key-stamper/index/ApiKeyStamper/readme.mdx +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: "ApiKeyStamper" -mode: wide ---- - -# Class: ApiKeyStamper - -Defined in: [index.ts:53](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L53) - -Stamper to use with `@turnkey/http`'s `TurnkeyClient` - -## Constructors - -### Constructor - -> **new ApiKeyStamper**(`config`): `ApiKeyStamper` - -Defined in: [index.ts:57](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L57) - -#### Parameters - -##### config - -[`TApiKeyStamperConfig`](../TApiKeyStamperConfig/readme) - -#### Returns - -`ApiKeyStamper` - -## Properties - -### apiPrivateKey - -> **apiPrivateKey**: `string` - -Defined in: [index.ts:55](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L55) - -*** - -### apiPublicKey - -> **apiPublicKey**: `string` - -Defined in: [index.ts:54](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L54) - -## Methods - -### stamp() - -> **stamp**(`payload`): `Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> - -Defined in: [index.ts:62](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L62) - -#### Parameters - -##### payload - -`string` - -#### Returns - -`Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> diff --git a/generated-docs/sdks/api-key-stamper/index/TApiKeyStamperConfig/readme.mdx b/generated-docs/sdks/api-key-stamper/index/TApiKeyStamperConfig/readme.mdx deleted file mode 100644 index d1a6e4270..000000000 --- a/generated-docs/sdks/api-key-stamper/index/TApiKeyStamperConfig/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "TApiKeyStamperConfig" -mode: wide ---- - -# Type Alias: TApiKeyStamperConfig - -> **TApiKeyStamperConfig** = `object` - -Defined in: [index.ts:7](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L7) - -## Properties - -### apiPrivateKey - -> **apiPrivateKey**: `string` - -Defined in: [index.ts:9](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L9) - -*** - -### apiPublicKey - -> **apiPublicKey**: `string` - -Defined in: [index.ts:8](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L8) diff --git a/generated-docs/sdks/api-key-stamper/index/pointDecode/readme.mdx b/generated-docs/sdks/api-key-stamper/index/pointDecode/readme.mdx deleted file mode 100644 index a503cdfad..000000000 --- a/generated-docs/sdks/api-key-stamper/index/pointDecode/readme.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "PointDecode" -mode: wide ---- - -# Function: pointDecode() - -> **pointDecode**(`point`): `JsonWebKey` - -Defined in: [tink/elliptic\_curves.ts:166](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/tink/elliptic_curves.ts#L166) - -Decodes a public key in _compressed_ OR _uncompressed_ format. -Augmented to ensure that the x and y components are padded to fit 32 bytes. - -P-256 only - -## Parameters - -### point - -`Uint8Array` - -## Returns - -`JsonWebKey` diff --git a/generated-docs/sdks/api-key-stamper/index/readme.mdx b/generated-docs/sdks/api-key-stamper/index/readme.mdx deleted file mode 100644 index 996051f81..000000000 --- a/generated-docs/sdks/api-key-stamper/index/readme.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Classes - -- [ApiKeyStamper](ApiKeyStamper/readme) - -## Type Aliases - -- [TApiKeyStamperConfig](TApiKeyStamperConfig/readme) - -## Functions - -- [pointDecode](pointDecode/readme) -- [signWithApiKey](signWithApiKey/readme) diff --git a/generated-docs/sdks/api-key-stamper/index/signWithApiKey/readme.mdx b/generated-docs/sdks/api-key-stamper/index/signWithApiKey/readme.mdx deleted file mode 100644 index c318956e4..000000000 --- a/generated-docs/sdks/api-key-stamper/index/signWithApiKey/readme.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "SignWithApiKey" -mode: wide ---- - -# Function: signWithApiKey() - -> **signWithApiKey**(`input`): `Promise`\<`string`\> - -Defined in: [index.ts:31](https://github.com/tkhq/sdk/blob/main/packages/api-key-stamper/src/index.ts#L31) - -Signature function abstracting the differences between NodeJS and web environments for signing with API keys. - -## Parameters - -### input - -#### content - -`string` - -#### privateKey - -`string` - -#### publicKey - -`string` - -## Returns - -`Promise`\<`string`\> diff --git a/generated-docs/sdks/api-key-stamper/readme.mdx b/generated-docs/sdks/api-key-stamper/readme.mdx deleted file mode 100644 index bd9fc3565..000000000 --- a/generated-docs/sdks/api-key-stamper/readme.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "API Key Stamper" -mode: wide ---- - -# @turnkey/api-key-stamper - -[![npm](https://img.shields.io/npm/v/@turnkey/api-key-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/api-key-stamper) - -This package contains functions to stamp a Turnkey request. It is meant to be used with [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http) - -Usage: - -```ts -import { ApiKeyStamper } from "@turnkey/api-key-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -const stamper = new ApiKeyStamper({ - apiPublicKey: "...", - apiPrivateKey: "...", -}); - -const httpClient = new TurnkeyClient( - { baseUrl: "https://api.turnkey.com" }, - stamper -); -``` - -## Documents - -- [ApiKeyStamper](ApiKeyStamper/readme) - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/core/index/ApiKeyStamper/readme.mdx b/generated-docs/sdks/core/index/ApiKeyStamper/readme.mdx deleted file mode 100644 index 28a6e0766..000000000 --- a/generated-docs/sdks/core/index/ApiKeyStamper/readme.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "ApiKeyStamper" -mode: wide ---- - -# Class: ApiKeyStamper - -Defined in: api-key-stamper/dist/index.d.ts:19 - -Stamper to use with `@turnkey/http`'s `TurnkeyClient` - -## Constructors - -### Constructor - -> **new ApiKeyStamper**(`config`): `ApiKeyStamper` - -Defined in: api-key-stamper/dist/index.d.ts:23 - -#### Parameters - -##### config - -[`TApiKeyStamperConfig`](../TApiKeyStamperConfig/readme) - -#### Returns - -`ApiKeyStamper` - -## Properties - -### apiPrivateKey - -> **apiPrivateKey**: `string` - -Defined in: api-key-stamper/dist/index.d.ts:21 - -*** - -### apiPublicKey - -> **apiPublicKey**: `string` - -Defined in: api-key-stamper/dist/index.d.ts:20 - -*** - -### runtimeOverride? - -> `optional` **runtimeOverride**: [`Runtime`](../../../api-key-stamper/index/Runtime/readme) - -Defined in: api-key-stamper/dist/index.d.ts:22 - -## Methods - -### stamp() - -> **stamp**(`payload`): `Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> - -Defined in: api-key-stamper/dist/index.d.ts:24 - -#### Parameters - -##### payload - -`string` - -#### Returns - -`Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> diff --git a/generated-docs/sdks/core/index/TApiKeyStamperConfig/readme.mdx b/generated-docs/sdks/core/index/TApiKeyStamperConfig/readme.mdx deleted file mode 100644 index 15cc5c27b..000000000 --- a/generated-docs/sdks/core/index/TApiKeyStamperConfig/readme.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "TApiKeyStamperConfig" -mode: wide ---- - -# Type Alias: TApiKeyStamperConfig - -> **TApiKeyStamperConfig** = `object` - -Defined in: api-key-stamper/dist/index.d.ts:3 - -## Properties - -### apiPrivateKey - -> **apiPrivateKey**: `string` - -Defined in: api-key-stamper/dist/index.d.ts:5 - -*** - -### apiPublicKey - -> **apiPublicKey**: `string` - -Defined in: api-key-stamper/dist/index.d.ts:4 - -*** - -### runtimeOverride? - -> `optional` **runtimeOverride**: [`Runtime`](../../../api-key-stamper/index/Runtime/readme) - -Defined in: api-key-stamper/dist/index.d.ts:6 diff --git a/generated-docs/sdks/core/index/TWebauthnStamperConfig/readme.mdx b/generated-docs/sdks/core/index/TWebauthnStamperConfig/readme.mdx deleted file mode 100644 index dd994158e..000000000 --- a/generated-docs/sdks/core/index/TWebauthnStamperConfig/readme.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: "TWebauthnStamperConfig" -mode: wide ---- - -# Type Alias: TWebauthnStamperConfig - -> **TWebauthnStamperConfig** = `object` - -Defined in: webauthn-stamper/dist/index.d.ts:2 - -## Properties - -### allowCredentials? - -> `optional` **allowCredentials**: `PublicKeyCredentialDescriptor`[] - -Defined in: webauthn-stamper/dist/index.d.ts:6 - -*** - -### rpId - -> **rpId**: `string` - -Defined in: webauthn-stamper/dist/index.d.ts:3 - -*** - -### timeout? - -> `optional` **timeout**: `number` - -Defined in: webauthn-stamper/dist/index.d.ts:4 - -*** - -### userVerification? - -> `optional` **userVerification**: `UserVerificationRequirement` - -Defined in: webauthn-stamper/dist/index.d.ts:5 diff --git a/generated-docs/sdks/core/index/TurnkeyClient/readme.mdx b/generated-docs/sdks/core/index/TurnkeyClient/readme.mdx deleted file mode 100644 index 6d0ef3901..000000000 --- a/generated-docs/sdks/core/index/TurnkeyClient/readme.mdx +++ /dev/null @@ -1,2608 +0,0 @@ ---- -title: "TurnkeyClient" -mode: wide ---- - -# Class: TurnkeyClient - -Defined in: [core/src/\_\_clients\_\_/core.ts:97](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L97) - -## Constructors - -### Constructor - -> **new TurnkeyClient**(`config`, `apiKeyStamper?`, `passkeyStamper?`, `walletManager?`): `TurnkeyClient` - -Defined in: [core/src/\_\_clients\_\_/core.ts:106](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L106) - -#### Parameters - -##### config - -[`TurnkeySDKClientConfig`](../../../react-wallet-kit/index/TurnkeySDKClientConfig/readme) - -##### apiKeyStamper? - -`CrossPlatformApiKeyStamper` - -##### passkeyStamper? - -`CrossPlatformPasskeyStamper` - -##### walletManager? - -`WalletManagerBase` - -#### Returns - -`TurnkeyClient` - -## Properties - -### config - -> **config**: [`TurnkeySDKClientConfig`](../../../react-wallet-kit/index/TurnkeySDKClientConfig/readme) - -Defined in: [core/src/\_\_clients\_\_/core.ts:98](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L98) - -*** - -### httpClient - -> **httpClient**: `TurnkeySDKClientBase` - -Defined in: [core/src/\_\_clients\_\_/core.ts:99](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L99) - -## Methods - -### addOauthProvider() - -> **addOauthProvider**(`params`): `Promise`\<`string`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2530](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2530) - -Adds an OAuth provider to the user. - -- This function adds an OAuth provider (e.g., Google, Apple) to the user account. -- If a userId is provided, it adds the provider for that specific user; otherwise, it uses the current session's userId. -- Automatically checks if an account already exists for the provided OIDC token and prevents duplicate associations. -- If the user's email is not set or not verified, attempts to update and verify the email using the email from the OIDC token. -- Handles session management and error reporting for the add provider flow. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### oidcToken - -`string` - -OIDC token for the OAuth provider. - -###### providerName - -`string` - -name of the OAuth provider to add (e.g., "Google", "Apple"). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to add the provider for a specific user (defaults to current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of provider IDs associated with the user. - -#### Throws - -If there is no active session, if the account already exists, or if there is an error adding the OAuth provider. - -*** - -### addPasskey() - -> **addPasskey**(`params?`): `Promise`\<`string`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2689](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2689) - -Adds a new passkey authenticator for the user. - -- This function prompts the user to create a new passkey (WebAuthn/FIDO2) and adds it as an authenticator for the user. -- Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow. -- If a userId is provided, the passkey is added for that specific user; otherwise, it uses the current session's userId. -- The passkey's name and display name can be customized; if not provided, defaults are generated. -- The resulting passkey attestation and challenge are registered with Turnkey as a new authenticator. - -#### Parameters - -##### params? - -###### displayName? - -`string` - -display name of the passkey (defaults to the value of `name`). - -###### name? - -`string` - -name of the passkey (defaults to "Turnkey Passkey-`timestamp`"). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to add the passkey for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of authenticator IDs for the newly added passkey(s). - -#### Throws - -If there is no active session, if passkey creation fails, or if there is an error adding the passkey. - -*** - -### clearAllSessions() - -> **clearAllSessions**(): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3394](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3394) - -Clears all sessions and resets the active session state. - -- This function removes all session data from the client and persistent storage, including all associated key pairs. -- Iterates through all stored session keys, clearing each session and deleting its corresponding API key pair. -- After clearing, there will be no active session, and all session-related data will be removed from local storage. -- Throws an error if no sessions exist or if there is an error during the clearing process. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when all sessions are successfully cleared. - -#### Throws - -If no sessions exist or if there is an error clearing all sessions. - -*** - -### clearSession() - -> **clearSession**(`params?`): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3361](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3361) - -Clears the session associated with the specified session key, or the active session by default. - -- This function deletes the session and its associated key pair from storage. -- If a sessionKey is provided, it will clear the session under that key; otherwise, it will clear the default (active) session. -- Removes the session data from local storage and deletes the corresponding API key pair from the key store. -- Throws an error if the session does not exist or if there is an error during the clearing process. - -#### Parameters - -##### params? - -###### sessionKey? - -`string` - -session key to clear the session under (defaults to the default session key). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the session is successfully cleared. - -#### Throws - -If the session does not exist or if there is an error clearing the session. - -*** - -### clearUnusedKeyPairs() - -> **clearUnusedKeyPairs**(): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3628](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3628) - -Clears any unused API key pairs from persistent storage. - -- This function scans all API key pairs stored in indexedDB and removes any key pairs that are not associated with a session in persistent storage. -- Ensures that only key pairs referenced by existing sessions are retained, preventing orphaned or stale key pairs from accumulating. -- Iterates through all stored session keys and builds a map of in-use public keys, then deletes any key pairs not present in this map. -- Intended to be called after session changes (e.g., login, logout, session replacement) to keep key storage clean and secure. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when all unused key pairs are successfully cleared. - -#### Throws - -If there is an error listing, checking, or deleting unused key pairs. - -*** - -### completeOauth() - -> **completeOauth**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1426](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1426) - -Completes the OAuth authentication flow by either signing up or logging in the user, depending on whether a sub-organization already exists for the provided OIDC token. - -- This function first checks if there is an existing sub-organization associated with the OIDC token. -- If a sub-organization exists, it proceeds with the OAuth login flow. -- If no sub-organization exists, it creates a new sub-organization and completes the sign-up flow. -- Optionally accepts a custom OAuth provider name, session key, and additional sub-organization creation parameters. -- Handles session storage and management, and supports invalidating existing sessions if specified. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../../../react-wallet-kit/index/CreateSubOrgParams/readme) - -parameters for sub-organization creation (e.g., authenticators, user metadata). - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing sessions for the user. - -###### oidcToken - -`string` - -OIDC token received after successful authentication with the OAuth provider. - -###### providerName? - -`string` - -name of the OAuth provider (defaults to a generated name with a timestamp). - -###### publicKey - -`string` - -public key to use for authentication. Must be generated prior to calling this function. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the user. - -#### Throws - -If there is an error during the OAuth completion process, such as account lookup, sign-up, or login. - -*** - -### completeOtp() - -> **completeOtp**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1344](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1344) - -Completes the OTP authentication flow by verifying the OTP code and then either signing up or logging in the user. - -- This function first verifies the OTP code for the provided contact and OTP type. -- If the contact is not associated with an existing sub-organization, it will automatically create a new sub-organization and complete the sign-up flow. -- If the contact is already associated with a sub-organization, it will complete the login flow. -- Supports passing a custom public key for authentication, invalidating existing session, specifying a session key, and providing additional sub-organization creation parameters. -- Handles both email and SMS OTP types. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../../../react-wallet-kit/index/CreateSubOrgParams/readme) - -parameters for sub-organization creation (e.g., authenticators, user metadata). - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing sessions for the user. - -###### otpCode - -`string` - -OTP code entered by the user. - -###### otpId - -`string` - -ID of the OTP to complete (returned from `initOtp`). - -###### otpType - -[`OtpType`](../../../react-wallet-kit/index/OtpType/readme) - -type of OTP being completed (OtpType.Email or OtpType.Sms). - -###### publicKey? - -`string` - -public key to use for authentication. If not provided, a new key pair may be generated. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the user. - -#### Throws - -If there is an error during OTP verification, sign-up, or login. - -*** - -### connectWalletAccount() - -> **connectWalletAccount**(`walletProvider`): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:529](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L529) - -Connects the specified wallet account. - -- Requires the wallet manager and its connector to be initialized. - -#### Parameters - -##### walletProvider - -`WalletProvider` - -wallet provider to connect. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves once the wallet account is connected. - -#### Throws - -If the wallet manager is uninitialized or the connection fails. - -*** - -### createApiKeyPair() - -> **createApiKeyPair**(`params?`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3680](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3680) - -Creates a new API key pair and returns the public key. - -- This function generates a new API key pair and stores it in the underlying key store (IndexedDB). -- If an external key pair is provided, it will use that key pair for creation instead of generating a new one. -- If `storeOverride` is set to true, the generated or provided public key will be set as the override key in the API key stamper, making it the active key for subsequent signing operations. -- Ensures the API key stamper is initialized before proceeding. -- Handles both native CryptoKeyPair objects and raw key material. - -#### Parameters - -##### params? - -###### externalKeyPair? - -`CryptoKeyPair` \| \{ `privateKey`: `string`; `publicKey`: `string`; \} - -An externally generated key pair (either a CryptoKeyPair or an object with publicKey/privateKey strings) to use instead of generating a new one. - -###### storeOverride? - -`boolean` - -If true, sets the generated or provided public key as the override key in the API key stamper (defaults to false). -@returnparams.s A promise that resolves to the public key of the created or provided API key pair as a string. - -#### Returns - -`Promise`\<`string`\> - -#### Throws - -If the API key stamper is not initialized or if there is an error during key pair creation or storage. - -*** - -### createPasskey() - -> **createPasskey**(`params?`): `Promise`\<\{ `attestation`: [`v1Attestation`](../../../_turnkey/sdk-types/v1Attestation/readme); `encodedChallenge`: `string`; \}\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:179](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L179) - -Creates a new passkey authenticator for the user. - -- This function generates a new passkey attestation and challenge, suitable for registration with the user's device. -- Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow. -- The resulting attestation and challenge can be used to register the passkey with Turnkey. - -#### Parameters - -##### params? - -###### displayName? - -`string` - -display name for the passkey. If not provided, defaults to "A Passkey". - -###### name? - -`string` - -name of the passkey. If not provided, defaults to "A Passkey". - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Returns - -`Promise`\<\{ `attestation`: [`v1Attestation`](../../../_turnkey/sdk-types/v1Attestation/readme); `encodedChallenge`: `string`; \}\> - -A promise that resolves to an object containing: - - attestation: attestation object returned from the passkey creation process. - - encodedChallenge: encoded challenge string used for passkey registration. - -#### Throws - -If there is an error during passkey creation, or if the platform is unsupported. - -*** - -### createWallet() - -> **createWallet**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2820](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2820) - -Creates a new wallet for sub-organization. - -- This function creates a new wallet for the current sub-organization. -- If an organizationId is provided, the wallet will be created under that specific sub-organization; otherwise, it uses the current session's organizationId. -- If a list of address formats is provided, accounts will be created in the wallet based on those formats (starting from path index 0). -- If a list of account parameters is provided, those accounts will be created in the wallet. -- If no accounts or address formats are provided, default Ethereum and Solana accounts will be created. -- Optionally allows specifying the mnemonic length for the wallet seed phrase (defaults to 12). -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### accounts? - -[`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] \| [`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme)[] - -array of account parameters or address formats to create in the wallet. - -###### mnemonicLength? - -`number` - -mnemonic length for the wallet seed phrase (defaults to 12). - -###### organizationId? - -`string` - -organization ID to create the wallet under a specific sub-organization (defaults to the current session's organizationId). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### walletName - -`string` - -name of the wallet to create. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the ID of the newly created wallet. - -#### Throws - -If there is no active session or if there is an error creating the wallet. - -*** - -### createWalletAccounts() - -> **createWalletAccounts**(`params`): `Promise`\<`string`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2893](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2893) - -Creates new accounts in the specified wallet. - -- This function creates new wallet accounts based on the provided account parameters or address formats. -- If a walletId is provided, it creates the accounts in that specific wallet; otherwise, it uses the current session's wallet. -- If a list of address formats is provided, it will create accounts in the wallet based on those formats, automatically determining the next available path indexes to avoid duplicates with existing accounts. -- If account parameters are provided, they are used directly for account creation. -- Automatically queries existing wallet accounts to prevent duplicate account creation for the same address format and path. -- Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### accounts - -[`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] \| [`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme)[] - -An array of account parameters or address formats to create in the wallet. - -###### organizationId? - -`string` - -organization ID to create the accounts under a specific organization (walletId must be associated with the sub-organization). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### walletId - -`string` - -ID of the wallet to create accounts in. - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of addresses for the newly created accounts. - -#### Throws - -If there is no active session, if the wallet does not exist, or if there is an error creating the wallet accounts. - -*** - -### deleteSubOrganization() - -> **deleteSubOrganization**(`params?`): `Promise`\<[`TDeleteSubOrganizationResponse`](../../../_turnkey/sdk-types/TDeleteSubOrganizationResponse/readme)\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3287](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3287) - -Deletes the current sub-organization (sub-org) for the active session. - -- This function deletes the sub-organization associated with the current active session. -- By default, the deletion will fail if any wallets associated with the sub-organization have not been exported. -- If `deleteWithoutExport` is set to true, the sub-organization will be deleted even if its wallets have not been exported (potentially resulting in loss of access to those wallets). -- Requires an active session; otherwise, an error is thrown. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### deleteWithoutExport? - -`boolean` - -flag to delete the sub-organization without requiring all wallets to be exported first (defaults to false). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper. - -#### Returns - -`Promise`\<[`TDeleteSubOrganizationResponse`](../../../_turnkey/sdk-types/TDeleteSubOrganizationResponse/readme)\> - -A promise that resolves to a `TDeleteSubOrganizationResponse` object containing the result of the deletion. - -#### Throws - -If there is no active session or if there is an error deleting the sub-organization. - -*** - -### disconnectWalletAccount() - -> **disconnectWalletAccount**(`walletProvider`): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:556](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L556) - -Disconnects the specified wallet account. - -- Requires the wallet manager and its connector to be initialized. - -#### Parameters - -##### walletProvider - -`WalletProvider` - -wallet provider to disconnect. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves once the wallet account is disconnected. - -#### Throws - -If the wallet manager is uninitialized or the disconnection fails. - -*** - -### exportPrivateKey() - -> **exportPrivateKey**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3026](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3026) - -Exports a private key as an encrypted bundle. - -- This function exports the specified private key as an encrypted bundle, suitable for backup or transfer. -- The exported bundle contains the private key's key material, encrypted to the provided target public key. -- If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown. -- If an organizationId is provided, the private key will be exported under that sub-organization; otherwise, the current session's organizationId is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### organizationId? - -`string` - -organization ID to export the private key under a specific sub - -###### privateKeyId - -`string` - -ID of the private key to export. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### targetPublicKey - -`string` - -public key to encrypt the bundle to (required). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to an `ExportBundle` object containing the encrypted private key and metadata. - -#### Throws - -If there is no active session, if the targetPublicKey is missing, or if there is an error exporting the private key. - -*** - -### exportWallet() - -> **exportWallet**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2970](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2970) - -Exports a wallet as an encrypted bundle. - -- This function exports the specified wallet and its accounts as an encrypted bundle, suitable for backup or transfer. -- The exported bundle contains the wallet's seed phrase, encrypted to the provided target public key. -- If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown. -- If an organizationId is provided, the wallet will be exported under that sub-organization; otherwise, the current session's organizationId is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- The exported bundle can later be imported using the `importWallet` method. - -#### Parameters - -##### params - -###### organizationId? - -`string` - -organization ID to export the wallet under a specific sub-organization (walletId must be associated with the sub-organization). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### targetPublicKey - -`string` - -public key to encrypt the bundle to (required). - -###### walletId - -`string` - -ID of the wallet to export. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to an `ExportBundle` object containing the encrypted wallet seed phrase and metadata. - -#### Throws - -If there is no active session, if the targetPublicKey is missing, or if there is an error exporting the wallet. - -*** - -### exportWalletAccount() - -> **exportWalletAccount**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3082](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3082) - -Exports a wallet account as an encrypted bundle. - -- This function exports the specified wallet account as an encrypted bundle, suitable for backup or transfer. -- The exported bundle contains the wallet account's key material, encrypted to the provided target public key. -- If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown. -- If an organizationId is provided, the wallet account will be exported under that sub-organization; otherwise, the current session's organizationId is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### address - -`string` - -address of the wallet account to export. - -###### organizationId? - -`string` - -organization ID to export the wallet account under a specific sub-organization. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### targetPublicKey - -`string` - -public key to encrypt the bundle to. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to an `ExportBundle` object containing the encrypted wallet account and metadata. - -#### Throws - -If there is no active session, if the targetPublicKey is missing, or if there is an error exporting the wallet account. - -*** - -### fetchUser() - -> **fetchUser**(`params?`): `Promise`\<[`v1User`](../../../_turnkey/sdk-types/v1User/readme)\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2178](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2178) - -Fetches the user details for the current session or a specified user. - -- Retrieves user details from the Turnkey API using the provided userId and organizationId, or defaults to those from the active session. -- If no userId is provided, the userId from the current session is used. -- If no organizationId is provided, the organizationId from the current session is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Ensures that an active session exists before making the request. - -#### Parameters - -##### params? - -###### organizationId? - -`string` - -organization ID to specify the sub-organization (defaults to the current session's organizationId). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to fetch specific user details (defaults to the current session's userId). - -#### Returns - -`Promise`\<[`v1User`](../../../_turnkey/sdk-types/v1User/readme)\> - -A promise that resolves to a `v1User` object containing the user details. - -#### Throws - -If there is no active session, if there is no userId, or if there is an error fetching user details. - -*** - -### fetchWalletAccounts() - -> **fetchWalletAccounts**(`params`): `Promise`\<`WalletAccount`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1763](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1763) - -Fetches all accounts for a specific wallet, including both embedded and connected wallet accounts. - -- For embedded wallets, retrieves accounts from the Turnkey API, supporting pagination (defaults to the first page with a limit of 100 accounts). -- For connected wallets (e.g., browser extensions or external providers), constructs account objects for each connected address from the provided or discovered wallet providers. -- Automatically determines the account type and populates relevant fields such as address, curve, and signing capability. -- Optionally allows filtering by a specific set of wallet providers and supports custom pagination options. -- Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### paginationOptions? - -[`v1Pagination`](../../../_turnkey/sdk-types/v1Pagination/readme) - -pagination options for embedded wallets. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### wallet - -`Wallet` - -wallet for which to fetch accounts. - -###### walletProviders? - -`WalletProvider`[] - -list of wallet providers to filter by (used for connected wallets). - -#### Returns - -`Promise`\<`WalletAccount`[]\> - -A promise that resolves to an array of `v1WalletAccount` objects. - -#### Throws - -If no active session is found or if there is an error fetching wallet accounts. - -*** - -### fetchWallets() - -> **fetchWallets**(`params?`): `Promise`\<`Wallet`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1648](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1648) - -Fetches all wallets for the current user, including both embedded and connected wallets. - -- Retrieves all wallets associated with the organizationId from the current active session. -- For each embedded wallet, automatically fetches and attaches all associated wallet accounts. -- For connected wallets (e.g., browser extensions or external providers), groups providers by wallet name and attaches all connected accounts. -- Returns both embedded and connected wallets in a single array, each with their respective accounts populated. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Returns - -`Promise`\<`Wallet`[]\> - -A promise that resolves to an array of `Wallet` objects. - -#### Throws - -If no active session is found or if there is an error fetching wallets. - -*** - -### getActiveSessionKey() - -> **getActiveSessionKey**(): `Promise`\<`undefined` \| `string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3605](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3605) - -Retrieves the active session key currently set in persistent storage. - -- This function fetches the session key that is currently marked as active in the client's persistent storage. -- The active session key determines which session is used for all session-dependent operations. -- If no active session key is set, returns `undefined`. -- Useful for determining which session is currently in use, especially when managing multiple sessions. - -#### Returns - -`Promise`\<`undefined` \| `string`\> - -A promise that resolves to the active session key as a string, or `undefined` if no active session is set. - -#### Throws - -If there is an error retrieving the active session key from storage. - -*** - -### getAllSessions() - -> **getAllSessions**(): `Promise`\<`undefined` \| `Record`\<`string`, [`Session`](../../../sdk-browser/index/Session/readme)\>\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3546](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3546) - -Retrieves all sessions stored in persistent storage. - -- This function fetches all session objects currently stored by the client, including those that are not active. -- Returns a record mapping each session key to its corresponding `Session` object. -- Useful for session management, auditing, or displaying all available sessions to the user. -- Automatically skips any session keys that do not have a valid session object. - -#### Returns - -`Promise`\<`undefined` \| `Record`\<`string`, [`Session`](../../../sdk-browser/index/Session/readme)\>\> - -A promise that resolves to a record of session keys and their corresponding `Session` objects, or `undefined` if no sessions exist. - -#### Throws - -If there is an error retrieving sessions from storage. - -*** - -### getProxyAuthConfig() - -> **getProxyAuthConfig**(): `Promise`\<[`ProxyTGetWalletKitConfigResponse`](../../../_turnkey/sdk-types/ProxyTGetWalletKitConfigResponse/readme)\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3723](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3723) - -Fetches the WalletKit proxy authentication configuration from the auth proxy. - -- This function makes a request to the Turnkey auth proxy to retrieve the current WalletKit configuration, - including supported authentication methods, OAuth providers, and any custom proxy settings. -- Useful for dynamically configuring the client UI or authentication flows based on the proxy's capabilities. -- Ensures that the client is aware of the latest proxy-side configuration, which may affect available login/signup options. - -#### Returns - -`Promise`\<[`ProxyTGetWalletKitConfigResponse`](../../../_turnkey/sdk-types/ProxyTGetWalletKitConfigResponse/readme)\> - -A promise that resolves to a `ProxyTGetWalletKitConfigResponse` object containing the proxy authentication configuration. - -#### Throws - -If there is an error retrieving the proxy authentication configuration from the auth proxy. - -*** - -### getSession() - -> **getSession**(`params?`): `Promise`\<`undefined` \| [`Session`](../../../sdk-browser/index/Session/readme)\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3519](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3519) - -Retrieves the session associated with the specified session key, or the active session by default. - -- This function retrieves the session object from storage, using the provided session key or, if not specified, the current active session key. -- If no session key is provided and there is no active session, it returns undefined. -- Returns the session details, including public key, organization ID, user ID, and expiration. - -#### Parameters - -##### params? - -###### sessionKey? - -`string` - -session key to retrieve a specific session (defaults to the current active session key). - -#### Returns - -`Promise`\<`undefined` \| [`Session`](../../../sdk-browser/index/Session/readme)\> - -A promise that resolves to a `Session` object containing the session details, or undefined if not found. - -#### Throws - -If there is an error retrieving the session from storage. - -*** - -### getWalletProviders() - -> **getWalletProviders**(`chain?`): `Promise`\<`WalletProvider`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:501](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L501) - -Retrieves wallet providers from the initialized wallet manager. - -- Optionally filters providers by the specified blockchain chain. -- Throws an error if the wallet manager is not initialized. - -#### Parameters - -##### chain? - -`Chain` - -optional blockchain chain to filter the returned providers. - -#### Returns - -`Promise`\<`WalletProvider`[]\> - -A promise that resolves to an array of wallet providers. - -#### Throws - -If the wallet manager is uninitialized or provider retrieval fails. - -*** - -### importPrivateKey() - -> **importPrivateKey**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3213](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3213) - -Imports a private key from an encrypted bundle. - -- This function imports a private key using the provided encrypted bundle. -- If a userId is provided, the private key will be imported for that specific user; otherwise, it uses the current session's userId. -- Requires address formats to -- Automatically infers the cryptographic curve used to generate the private key based on the address format (can be optionally overriden if needed). -- The encrypted bundle MUST be encrypted to ensure security. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### addressFormats - -[`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme)[] - -###### curve - -[`v1Curve`](../../../_turnkey/sdk-types/v1Curve/readme) - -the cryptographic curve used to generate a given private key - -###### encryptedBundle - -`string` - -encrypted bundle containing the private key key material and metadata. - -###### privateKeyName - -`string` - -name of the private key to create upon import. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to import the wallet for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the ID of the imported wallet. - -#### Throws - -If there is no active session, if the encrypted bundle is invalid, or if there is an error importing the wallet. - -*** - -### importWallet() - -> **importWallet**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3139](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3139) - -Imports a wallet from an encrypted bundle. - -- This function imports a wallet using the provided encrypted bundle and creates accounts based on the provided parameters. -- If a userId is provided, the wallet will be imported for that specific user; otherwise, it uses the current session's userId. -- If an accounts array is provided, those accounts will be created in the imported wallet; otherwise, default Ethereum and Solana accounts will be created. -- The encrypted bundle MUST be encrypted to -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### accounts? - -[`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] - -array of account parameters to create in the imported wallet (defaults to standard Ethereum and Solana accounts). - -###### encryptedBundle - -`string` - -encrypted bundle containing the wallet seed phrase and metadata. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to import the wallet for a specific user (defaults to the current session's userId). - -###### walletName - -`string` - -name of the wallet to create upon import. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the ID of the imported wallet. - -#### Throws - -If there is no active session, if the encrypted bundle is invalid, or if there is an error importing the wallet. - -*** - -### init() - -> **init**(): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:124](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L124) - -#### Returns - -`Promise`\<`void`\> - -*** - -### initOtp() - -> **initOtp**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1073](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1073) - -Initializes the OTP process by sending an OTP code to the provided contact. - -- This function initiates the OTP flow by sending a one-time password (OTP) code to the user's contact information (email address or phone number) via the auth proxy. -- Supports both email and SMS OTP types. -- Returns an OTP ID that is required for subsequent OTP verification. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### otpType - -[`OtpType`](../../../react-wallet-kit/index/OtpType/readme) - -type of OTP to initialize (OtpType.Email or OtpType.Sms). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the OTP ID required for verification. - -#### Throws - -If there is an error during the OTP initialization process or if the maximum number of OTPs has been reached. - -*** - -### loginOrSignupWithWallet() - -> **loginOrSignupWithWallet**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:865](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L865) - -Logs in an existing user or signs up a new user using a wallet, creating a new sub-organization if needed. - -- This function attempts to log in the user by stamping a login request with the provided wallet. -- If the wallet’s public key is not associated with an existing sub-organization, a new one is created. -- Handles both wallet authentication and sub-organization creation in a single flow. -- For Ethereum wallets, derives the public key from the signed request header; for Solana wallets, retrieves it directly from the wallet. -- Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration. -- Stores the resulting session token under the specified session key, or the default session key if not provided. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../../../react-wallet-kit/index/CreateSubOrgParams/readme) - -optional parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### sessionKey? - -`string` - -session key to use for storing the session (defaults to the default session key). - -###### walletProvider - -`WalletProvider` - -wallet provider to use for authentication. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the sub-organization (new or existing). - -#### Throws - -If there is an error during wallet authentication, sub-organization creation, or session storage. - -*** - -### loginWithOauth() - -> **loginWithOauth**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1498](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1498) - -Logs in a user using OAuth authentication. - -- This function logs in a user using the provided OIDC token and public key. -- Optionally invalidates any existing sessions for the user if `invalidateExisting` is set to true. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Handles cleanup of unused key pairs if login fails. - -#### Parameters - -##### params - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing sessions for the user. - -###### oidcToken - -`string` - -OIDC token received after successful authentication with the OAuth provider. - -###### publicKey - -`string` - -public key to use for authentication. Must be generated prior to calling this function. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token. - -#### Throws - -If there is an error during the OAuth login process or if key pair cleanup fails. - -*** - -### loginWithOtp() - -> **loginWithOtp**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1189](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1189) - -Logs in a user using an OTP verification token. - -- This function logs in a user using the verification token received after OTP verification (from email or SMS). -- If a public key is not provided, a new API key pair will be generated for authentication. -- Optionally invalidates any existing sessions for the user if `invalidateExisting` is set to true. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Handles cleanup of unused key pairs if login fails. - -#### Parameters - -##### params - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing session for the user. - -###### publicKey? - -`string` - -public key to use for authentication. If not provided, a new key pair will be generated. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -###### verificationToken - -`string` - -verification token received after OTP verification. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token. - -#### Throws - -If there is an error during the OTP login process or if key pair cleanup fails. - -*** - -### loginWithPasskey() - -> **loginWithPasskey**(`params?`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:301](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L301) - -Logs in a user using a passkey, optionally specifying the public key, session key, and session expiration. - -- This function initiates the login process with a passkey and handles session creation and storage. -- If a public key is not provided, a new key pair will be generated for authentication. -- If a session key is not provided, the default session key will be used. -- The session expiration can be customized via the expirationSeconds parameter. -- Handles cleanup of unused key pairs if login fails. - -#### Parameters - -##### params? - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### publicKey? - -`string` - -public key to use for authentication. If not provided, a new key pair will be generated. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token. - -#### Throws - -If there is an error during the passkey login process or if the user cancels the passkey prompt. - -*** - -### loginWithWallet() - -> **loginWithWallet**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:642](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L642) - -Logs in a user using the specified wallet provider. - -- This function logs in a user by authenticating with the provided wallet provider via a wallet-based signature. -- If a public key is not provided, a new one will be generated for authentication. -- Optionally accepts a custom session key and session expiration time. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Throws an error if a public key cannot be found or generated, or if the login process fails. - -#### Parameters - -##### params - -###### expirationSeconds? - -`string` - -optional session expiration time in seconds (defaults to the configured default). - -###### publicKey? - -`string` - -optional public key to associate with the session (generated if not provided). - -###### sessionKey? - -`string` - -optional key to store the session under (defaults to the default session key). - -###### walletProvider - -`WalletProvider` - -wallet provider to use for authentication. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the created session token. - -#### Throws - -If the wallet stamper is uninitialized, a public key cannot be found or generated, or login fails. - -*** - -### logout() - -> **logout**(`params?`): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:256](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L256) - -Logs out the current client session. - -- This function clears the specified session and removes any associated key pairs from storage. -- If a sessionKey is provided, it logs out from that session; otherwise, it logs out from the active session. -- Cleans up any api keys associated with the session. - -#### Parameters - -##### params? - -###### sessionKey? - -`string` - -session key to specify which session to log out from (defaults to the active session). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the logout process is complete. - -#### Throws - -If there is no active session or if there is an error during the logout process. - -*** - -### refreshSession() - -> **refreshSession**(`params?`): `Promise`\<`undefined` \| [`TStampLoginResponse`](../../../_turnkey/sdk-types/TStampLoginResponse/readme)\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3433](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3433) - -Refreshes the session associated with the specified session key, or the active session by default. - -- This function refreshes the session and updates the session token and key pair associated with the given session key. -- If a sessionKey is provided, it will refresh the session under that key; otherwise, it will use the current active session key. -- Optionally allows specifying a new expiration time for the session, a custom public key, and whether to invalidate the existing session after refreshing. -- Makes a request to the Turnkey API to stamp a new login and stores the refreshed session token. -- Automatically manages key pair cleanup and session storage to ensure consistency. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### expirationSeconds? - -`string` - -expiration time in seconds for the refreshed session (defaults to the configured default). - -###### invalidateExisitng? - -`boolean` - -flag to invalidate the existing session before refreshing (defaults to false). - -###### publicKey? - -`string` - -public key to use for the refreshed session (if not provided, a new key pair will be generated). - -###### sessionKey? - -`string` - -session key to refresh the session under (defaults to the active session key). - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper. - -#### Returns - -`Promise`\<`undefined` \| [`TStampLoginResponse`](../../../_turnkey/sdk-types/TStampLoginResponse/readme)\> - -A promise that resolves to a `TStampLoginResponse` object containing the refreshed session details. - -#### Throws - -If the session key does not exist, if there is no active session, or if there is an error refreshing the session. - -*** - -### removeOauthProviders() - -> **removeOauthProviders**(`params`): `Promise`\<`string`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2635](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2635) - -Removes a list of OAuth providers from the user. - -- This function removes OAuth providers (e.g., Google, Apple) from the user's account. -- If a userId is provided, it removes the providers for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Returns an array of remaining provider IDs associated with the user after removal. - -#### Parameters - -##### params - -###### providerIds - -`string`[] - -IDs of the OAuth providers to remove. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove the provider for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of provider IDs that were removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the OAuth provider. - -*** - -### removePasskeys() - -> **removePasskeys**(`params`): `Promise`\<`string`[]\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2762](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2762) - -Removes passkeys (authenticator) from the user. - -- This function removes passkeys (WebAuthn/FIDO2 authenticators) from the user's account. -- If a userId is provided, it removes the passkeys for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Returns an array of remaining authenticator IDs for the user after removal. - -#### Parameters - -##### params - -###### authenticatorIds - -`string`[] - -IDs of the authenticators (passkeys) to remove. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove the passkeys for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of authenticator IDs that were removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the passkeys. - -*** - -### removeUserEmail() - -> **removeUserEmail**(`params?`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2310](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2310) - -Removes the user's email address. - -- This function removes the user's email address by setting it to an empty string. -- If a userId is provided, it removes the email for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove a specific user's email address (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user whose email was removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the user email. - -*** - -### removeUserPhoneNumber() - -> **removeUserPhoneNumber**(`params?`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2419](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2419) - -Removes the user's phone number. - -- This function removes the user's phone number by setting it to an empty string. -- If a userId is provided, it removes the phone number for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove a specific user's phone number (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user whose phone number was removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the user phone number. - -*** - -### setActiveSession() - -> **setActiveSession**(`params`): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3581](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3581) - -Sets the active session to the specified session key. - -- This function updates the `activeSessionKey` in persistent storage to the specified session key. -- Ensures that subsequent operations use the session associated with this key as the active session. -- Does not validate whether the session key exists or is valid; it simply updates the pointer. -- Useful for switching between multiple stored sessions or restoring a previous session context. - -#### Parameters - -##### params - -###### sessionKey - -`string` - -session key to set as the active session. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the active session key is successfully set. - -#### Throws - -If the client is not initialized or if there is an error setting the active session key. - -*** - -### signAndSendTransaction() - -> **signAndSendTransaction**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2066](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2066) - -Signs and broadcasts a transaction using the specified wallet account. - -- For **connected wallets**: - - Calls the wallet’s native `signAndSendTransaction` method. - - Does **not** require an `rpcUrl`. - -- For **embedded wallets**: - - Signs the transaction using the Turnkey API. - - Requires an `rpcUrl` to broadcast the transaction. - - Broadcasts the transaction using a JSON-RPC client. - -#### Parameters - -##### params - -###### rpcUrl? - -`string` - -required for embedded wallets to broadcast the signed transaction. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -optional stamper to tag the signing request. - -###### transactionType - -[`v1TransactionType`](../../../_turnkey/sdk-types/v1TransactionType/readme) - -transaction type (e.g., "TRANSACTION_TYPE_SOLANA"). - -###### unsignedTransaction - -`string` - -unsigned transaction (serialized string). - -###### walletAccount - -`WalletAccount` - -wallet account to use for signing and sending. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a transaction signature or hash. - -#### Throws - -If signing or broadcasting fails. - -*** - -### signMessage() - -> **signMessage**(`params`): `Promise`\<[`v1SignRawPayloadResult`](../../../_turnkey/sdk-types/v1SignRawPayloadResult/readme)\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1896](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1896) - -Signs a message using the specified wallet account. - -- Supports both embedded and connected wallets. -- For **connected wallets**: - - Delegates signing to the wallet provider’s native signing method. - - **Important:** For Ethereum wallets (e.g., MetaMask), signatures follow [EIP-191](https://eips.ethereum.org/EIPS/eip-191). - The message is automatically prefixed with `"\x19Ethereum Signed Message:\n" + message length` - before signing. As a result, this signature **cannot be used as a raw transaction signature** - or broadcast on-chain. -- For **embedded wallets**, uses the Turnkey API to sign the message directly. -- Automatically handles message encoding and hashing based on the wallet account’s address format, - unless explicitly overridden. - -#### Parameters - -##### params - -###### addEthereumPrefix? - -`boolean` - -whether to prefix the message with Ethereum's `"\x19Ethereum Signed Message:\n"` string. - - If `true` (default for Ethereum), the message is prefixed before signing. - - If `false`: - - Connected wallets will throw an error because they always prefix automatically. - - Embedded wallets will sign the raw message without any prefix. - -###### encoding? - -[`v1PayloadEncoding`](../../../_turnkey/sdk-types/v1PayloadEncoding/readme) - -override for the payload encoding (defaults to the encoding appropriate for the address type). - -###### hashFunction? - -[`v1HashFunction`](../../../_turnkey/sdk-types/v1HashFunction/readme) - -override for the hash function (defaults to the hash function appropriate for the address type). - -###### message - -`string` - -message to sign. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -stamper to tag the signing request (e.g., Passkey, ApiKey, or Wallet). - -###### walletAccount - -`WalletAccount` - -wallet account to use for signing. - -#### Returns - -`Promise`\<[`v1SignRawPayloadResult`](../../../_turnkey/sdk-types/v1SignRawPayloadResult/readme)\> - -A promise resolving to a `v1SignRawPayloadResult` containing the signature and metadata. - -#### Throws - -If signing fails, if the wallet account does not support signing, or if the response is invalid. - -*** - -### signTransaction() - -> **signTransaction**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1994](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1994) - -Signs a transaction using the specified wallet account. - -- This function signs a blockchain transaction using the provided wallet address and transaction data. -- Supports all Turnkey-supported blockchain networks (e.g., Ethereum, Solana, Tron). -- Automatically determines the appropriate signing method based on the transaction type. -- Delegates signing to the Turnkey API, which returns the signed transaction and related metadata. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### transactionType - -[`v1TransactionType`](../../../_turnkey/sdk-types/v1TransactionType/readme) - -type of transaction (e.g., "TRANSACTION_TYPE_ETHEREUM", "TRANSACTION_TYPE_SOLANA", "TRANSACTION_TYPE_TRON"). - -###### unsignedTransaction - -`string` - -unsigned transaction data (serialized as a string) to be signed. - -###### walletAccount - -`WalletAccount` - -wallet account to use for signing the transaction. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a `TSignTransactionResponse` object containing the signed transaction and any additional signing metadata. - -#### Throws - -If there is an error signing the transaction or if the response is invalid. - -*** - -### signUpWithOauth() - -> **signUpWithOauth**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1591](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1591) - -Signs up a user using OAuth authentication. - -- This function creates a new sub-organization for the user using the provided OIDC token, public key, and provider name. -- Handles the full OAuth sign-up flow, including sub-organization creation and session management. -- Optionally accepts additional sub-organization creation parameters and a custom session key. -- After successful sign-up, automatically logs in the user and returns a signed JWT session token. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../../../react-wallet-kit/index/CreateSubOrgParams/readme) - -parameters for sub-organization creation (e.g., authenticators, user metadata). - -###### oidcToken - -`string` - -OIDC token received after successful authentication with the OAuth provider. - -###### providerName - -`string` - -name of the OAuth provider (e.g., "Google", "Apple"). - -###### publicKey - -`string` - -public key to associate with the new sub-organization. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during the OAuth sign-up or login process. - -*** - -### signUpWithOtp() - -> **signUpWithOtp**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1271](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1271) - -Signs up a user using an OTP verification token. - -- This function signs up a user using the verification token received after OTP verification (from email or SMS). -- Creates a new sub-organization for the user with the provided parameters and associates the contact (email or phone) with the sub-organization. -- Automatically generates a new API key pair for authentication and session management. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Handles both email and SMS OTP types, and supports additional sub-organization creation parameters. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../../../react-wallet-kit/index/CreateSubOrgParams/readme) - -parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing session for the user. - -###### otpType - -[`OtpType`](../../../react-wallet-kit/index/OtpType/readme) - -type of OTP being used (OtpType.Email or OtpType.Sms). - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -###### verificationToken - -`string` - -verification token received after OTP verification. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during the OTP sign-up process or session storage. - -*** - -### signUpWithPasskey() - -> **signUpWithPasskey**(`params?`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:384](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L384) - -Signs up a user using a passkey, creating a new sub-organization and session. - -- This function creates a new passkey authenticator and uses it to register a new sub-organization for the user. -- Handles both passkey creation and sub-organization creation in a single flow. -- Optionally accepts additional sub-organization parameters, a custom session key, a custom passkey display name, and a custom session expiration. -- Automatically generates a new API key pair for authentication and session management. -- Stores the resulting session token and manages cleanup of unused key pairs. - -#### Parameters - -##### params? - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../../../react-wallet-kit/index/CreateSubOrgParams/readme) - -parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### passkeyDisplayName? - -`string` - -display name for the passkey (defaults to a generated name based on the current timestamp). - -###### sessionKey? - -`string` - -session key to use for storing the session (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during passkey creation, sub-organization creation, or session storage. - -*** - -### signUpWithWallet() - -> **signUpWithWallet**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:732](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L732) - -Signs up a user using a wallet, creating a new sub-organization and session. - -- This function creates a new wallet authenticator and uses it to register a new sub-organization for the user. -- Handles both wallet authentication and sub-organization creation in a single flow. -- Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration. -- Automatically generates additional API key pairs for authentication and session management. -- Stores the resulting session token under the specified session key, or the default session key if not provided, and manages cleanup of unused key pairs. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../../../react-wallet-kit/index/CreateSubOrgParams/readme) - -parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### sessionKey? - -`string` - -session key to use for storing the session (defaults to the default session key). - -###### walletProvider - -`WalletProvider` - -wallet provider to use for authentication. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during wallet authentication, sub-organization creation, session storage, or cleanup. - -*** - -### storeSession() - -> **storeSession**(`params`): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:3328](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L3328) - -Stores a session token and updates the session associated with the specified session key, or by default the active session. - -- This function parses and stores a signed JWT session token in local storage, associating it with the given session key. -- If a sessionKey is provided, the session will be stored under that key; otherwise, it will use the default session key. -- If a session already exists for the session key, its associated key pair will be deleted before storing the new session. -- After storing the session, any unused key pairs are automatically cleared from storage. -- Ensures that session management is consistent and prevents orphaned key pairs. - -#### Parameters - -##### params - -###### sessionKey? - -`string` - -session key to store the session under (defaults to the default session key). - -###### sessionToken - -`string` - -JWT session token to store. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the session is successfully stored. - -#### Throws - -If there is an error storing the session or cleaning up key pairs. - -*** - -### switchWalletProviderChain() - -> **switchWalletProviderChain**(`walletProvider`, `chainOrId`): `Promise`\<`void`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:589](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L589) - -Switches the specified wallet provider to a different blockchain chain. - -- Requires the wallet manager and its connector to be initialized. -- The wallet provider must have at least one connected address. -- Does nothing if the wallet provider is already on the desired chain. - -#### Parameters - -##### walletProvider - -`WalletProvider` - -wallet provider to switch. - -##### chainOrId - -target chain as a chain ID string or SwitchableChain object. - -`string` | `SwitchableChain` - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves once the chain switch is complete. - -#### Throws - -If the wallet manager is uninitialized, the provider is not connected, or the switch fails. - -*** - -### updateUserEmail() - -> **updateUserEmail**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2241](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2241) - -Updates the user's email address. - -- This function updates the user's email address and, if provided, verifies it using a verification token (typically from an OTP flow). -- If a userId is provided, it updates the email for that specific user; otherwise, it uses the current session's userId. -- If a verificationToken is not provided, the email will be updated but will not be marked as verified. -- Automatically ensures an active session exists before making the request. -- Handles session management and error reporting for both update and verification flows. - -#### Parameters - -##### params - -###### email - -`string` - -new email address to set for the user. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to update a specific user's email (defaults to the current session's userId). - -###### verificationToken? - -`string` - -verification token from OTP email verification (required if verifying the email). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the updated user. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error updating or verifying the user email. - -*** - -### updateUserName() - -> **updateUserName**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2472](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2472) - -Updates the user's name. - -- This function updates the user's display name. -- If a userId is provided, it updates the name for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Handles session management and error reporting for the update flow. - -#### Parameters - -##### params - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to update a specific user's name (defaults to the current session's userId). - -###### userName - -`string` - -new name to set for the user. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the updated user. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error updating the user name. - -*** - -### updateUserPhoneNumber() - -> **updateUserPhoneNumber**(`params`): `Promise`\<`string`\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:2363](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L2363) - -Updates the user's phone number. - -- This function updates the user's phone number and, if provided, verifies it using a verification token (from an OTP flow). -- If a userId is provided, it updates the phone number for that specific user; otherwise, it uses the current session's userId. -- If a verificationToken is not provided, the phone number will be updated but will not be marked as verified. -- Automatically ensures an active session exists before making the request. -- Handles session management and error reporting for both update and verification flows. - -#### Parameters - -##### params - -###### phoneNumber - -`string` - -new phone number to set for the user. - -###### stampWith? - -[`StamperType`](../../../react-wallet-kit/index/StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to update a specific user's phone number (defaults to the current session's userId). - -###### verificationToken? - -`string` - -verification token from OTP phone verification (required if verifying the phone number). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the updated user. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error updating or verifying the user phone number. - -*** - -### verifyOtp() - -> **verifyOtp**(`params`): `Promise`\<\{ `subOrganizationId`: `string`; `verificationToken`: `string`; \}\> - -Defined in: [core/src/\_\_clients\_\_/core.ts:1121](https://github.com/tkhq/sdk/blob/main/packages/core/src/__clients__/core.ts#L1121) - -Verifies the OTP code sent to the user. - -- This function verifies the OTP code entered by the user against the OTP sent to their contact information (email or phone) using the auth proxy. -- If verification is successful, it returns the sub-organization ID associated with the contact (if it exists) and a verification token. -- The verification token can be used for subsequent login or sign-up flows. -- Handles both email and SMS OTP types. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### otpCode - -`string` - -OTP code entered by the user. - -###### otpId - -`string` - -ID of the OTP to verify (returned from `initOtp`). - -###### otpType - -[`OtpType`](../../../react-wallet-kit/index/OtpType/readme) - -type of OTP being verified (OtpType.Email or OtpType.Sms). - -#### Returns - -`Promise`\<\{ `subOrganizationId`: `string`; `verificationToken`: `string`; \}\> - -A promise that resolves to an object containing: - - subOrganizationId: sub-organization ID if the contact is already associated with a sub-organization, or an empty string if not. - - verificationToken: verification token to be used for login or sign-up. - -#### Throws - -If there is an error during the OTP verification process, such as an invalid code or network failure. diff --git a/generated-docs/sdks/core/index/WebauthnStamper/readme.mdx b/generated-docs/sdks/core/index/WebauthnStamper/readme.mdx deleted file mode 100644 index e25f21db5..000000000 --- a/generated-docs/sdks/core/index/WebauthnStamper/readme.mdx +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "WebauthnStamper" -mode: wide ---- - -# Class: WebauthnStamper - -Defined in: webauthn-stamper/dist/index.d.ts:11 - -Stamper to use with `@turnkey/http`'s `TurnkeyClient` - -## Constructors - -### Constructor - -> **new WebauthnStamper**(`config`): `WebauthnStamper` - -Defined in: webauthn-stamper/dist/index.d.ts:16 - -#### Parameters - -##### config - -[`TWebauthnStamperConfig`](../TWebauthnStamperConfig/readme) - -#### Returns - -`WebauthnStamper` - -## Properties - -### allowCredentials - -> **allowCredentials**: `PublicKeyCredentialDescriptor`[] - -Defined in: webauthn-stamper/dist/index.d.ts:15 - -*** - -### rpId - -> **rpId**: `string` - -Defined in: webauthn-stamper/dist/index.d.ts:12 - -*** - -### timeout - -> **timeout**: `number` - -Defined in: webauthn-stamper/dist/index.d.ts:13 - -*** - -### userVerification - -> **userVerification**: `UserVerificationRequirement` - -Defined in: webauthn-stamper/dist/index.d.ts:14 - -## Methods - -### stamp() - -> **stamp**(`payload`): `Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> - -Defined in: webauthn-stamper/dist/index.d.ts:17 - -#### Parameters - -##### payload - -`string` - -#### Returns - -`Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> diff --git a/generated-docs/sdks/core/index/addressFormatConfig/readme.mdx b/generated-docs/sdks/core/index/addressFormatConfig/readme.mdx deleted file mode 100644 index f94931ec4..000000000 --- a/generated-docs/sdks/core/index/addressFormatConfig/readme.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "AddressFormatConfig" -mode: wide ---- - -# Variable: addressFormatConfig - -> `const` **addressFormatConfig**: `Record`\<[`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme), `AddressFormatConfig`\> - -Defined in: [core/src/utils.ts:92](https://github.com/tkhq/sdk/blob/main/packages/core/src/utils.ts#L92) - -Configuration for all supported address formats. - -Includes: -- encoding type -- hash function -- default accounts for the address format -- display name for the address format - -```ts -// Example usage: -import { addressFormatConfig } from "@turnkey/sdk-core"; - -const config = addressFormatConfig["ADDRESS_FORMAT_ETHEREUM"]; -``` diff --git a/generated-docs/sdks/core/index/readme.mdx b/generated-docs/sdks/core/index/readme.mdx deleted file mode 100644 index 8f739a20f..000000000 --- a/generated-docs/sdks/core/index/readme.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Classes - -- [ApiKeyStamper](ApiKeyStamper/readme) -- [TurnkeyClient](TurnkeyClient/readme) -- [WebauthnStamper](WebauthnStamper/readme) - -## Type Aliases - -- [TApiKeyStamperConfig](TApiKeyStamperConfig/readme) -- [TWebauthnStamperConfig](TWebauthnStamperConfig/readme) - -## Variables - -- [addressFormatConfig](addressFormatConfig/readme) -- [signWithApiKey](signWithApiKey/readme) diff --git a/generated-docs/sdks/core/index/signWithApiKey/readme.mdx b/generated-docs/sdks/core/index/signWithApiKey/readme.mdx deleted file mode 100644 index eb7a2d916..000000000 --- a/generated-docs/sdks/core/index/signWithApiKey/readme.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "SignWithApiKey" -mode: wide ---- - -# Variable: signWithApiKey() - -> `const` **signWithApiKey**: (`input`, `runtimeOverride?`) => `Promise`\<`string`\> - -Defined in: api-key-stamper/dist/index.d.ts:11 - -Signature function abstracting the differences between NodeJS and web environments for signing with API keys. - -## Parameters - -### input - -#### content - -`string` - -#### privateKey - -`string` - -#### publicKey - -`string` - -### runtimeOverride? - -[`Runtime`](../../../api-key-stamper/index/Runtime/readme) - -## Returns - -`Promise`\<`string`\> diff --git a/generated-docs/sdks/core/readme.mdx b/generated-docs/sdks/core/readme.mdx deleted file mode 100644 index 3142aa332..000000000 --- a/generated-docs/sdks/core/readme.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Core" -mode: wide ---- - -# @turnkey/core - -A core JavaScript web and React Native package for interfacing with Turnkey's infrastructure. - -If you're using React, please use `@turnkey/react-wallet-kit` instead - -## Documents - - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/cosmjs/documents/docs/readme.mdx b/generated-docs/sdks/cosmjs/documents/docs/readme.mdx deleted file mode 100644 index a29d90ea8..000000000 --- a/generated-docs/sdks/cosmjs/documents/docs/readme.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Docs" -mode: wide ---- - -[**Documentation**](../../../readme) - -*** - -[Documentation](../../../modules) / [cosmjs](../../readme) / documents/docs - ---- -title: "CosmJS" -description: "[`@turnkey/cosmjs`](https://www.npmjs.com/package/@turnkey/cosmjs) exports a `TurnkeyDirectWallet` that serves as a drop-in replacement for a CosmJS direct wallet. It includes support for `signDirect`. See full implementation [here](https://github.com/tkhq/sdk/tree/main/packages/cosmjs) for more details and examples." -mode: wide ---- - -```js -// Initialize a Turnkey Signer -const turnkeySigner = await TurnkeyDirectWallet.init({ - config: { - ... - }, - prefix: "celestia", // can be replaced with other Cosmos chains -}); - -const account = refineNonNull((await turnkeySigner.getAccounts())[0]); -const compressedPublicKey = toHex(account.pubkey); -const selfAddress = account.address; -``` diff --git a/generated-docs/sdks/cosmjs/index/TurnkeyActivityError/readme.mdx b/generated-docs/sdks/cosmjs/index/TurnkeyActivityError/readme.mdx deleted file mode 100644 index b10135ab7..000000000 --- a/generated-docs/sdks/cosmjs/index/TurnkeyActivityError/readme.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "TurnkeyActivityError" -mode: wide ---- - -# Class: TurnkeyActivityError - -Defined in: http/dist/shared.d.ts:9 - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new TurnkeyActivityError**(`input`): `TurnkeyActivityError` - -Defined in: http/dist/shared.d.ts:14 - -#### Parameters - -##### input - -###### activityId? - -`string` - -###### activityStatus? - -`"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -###### activityType? - -`"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -###### cause? - -`Error` - -###### message - -`string` - -#### Returns - -`TurnkeyActivityError` - -#### Overrides - -`Error.constructor` - -## Properties - -### activityId - -> **activityId**: `undefined` \| `string` - -Defined in: http/dist/shared.d.ts:10 - -*** - -### activityStatus - -> **activityStatus**: `undefined` \| `"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -Defined in: http/dist/shared.d.ts:11 - -*** - -### activityType - -> **activityType**: `undefined` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -Defined in: http/dist/shared.d.ts:12 - -*** - -### cause - -> **cause**: `undefined` \| `Error` - -Defined in: http/dist/shared.d.ts:13 diff --git a/generated-docs/sdks/cosmjs/index/TurnkeyDirectWallet/readme.mdx b/generated-docs/sdks/cosmjs/index/TurnkeyDirectWallet/readme.mdx deleted file mode 100644 index f4e3de401..000000000 --- a/generated-docs/sdks/cosmjs/index/TurnkeyDirectWallet/readme.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "TurnkeyDirectWallet" -mode: wide ---- - -# Class: TurnkeyDirectWallet - -Defined in: [cosmjs/src/index.ts:41](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L41) - -## Implements - -- `OfflineDirectSigner` - -## Properties - -### organizationId - -> `readonly` **organizationId**: `string` - -Defined in: [cosmjs/src/index.ts:90](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L90) - -*** - -### prefix - -> `readonly` **prefix**: `string` - -Defined in: [cosmjs/src/index.ts:89](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L89) - -*** - -### signWith - -> `readonly` **signWith**: `string` - -Defined in: [cosmjs/src/index.ts:91](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L91) - -## Methods - -### getAccounts() - -> **getAccounts**(): `Promise`\ - -Defined in: [cosmjs/src/index.ts:122](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L122) - -#### Returns - -`Promise`\ - -#### Implementation of - -`OfflineDirectSigner.getAccounts` - -*** - -### signDirect() - -> **signDirect**(`address`, `signDoc`): `Promise`\<`DirectSignResponse`\> - -Defined in: [cosmjs/src/index.ts:132](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L132) - -#### Parameters - -##### address - -`string` - -##### signDoc - -`SignDoc` - -#### Returns - -`Promise`\<`DirectSignResponse`\> - -#### Implementation of - -`OfflineDirectSigner.signDirect` - -*** - -### init() - -> `static` **init**(`input`): `Promise`\<`TurnkeyDirectWallet`\> - -Defined in: [cosmjs/src/index.ts:42](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L42) - -#### Parameters - -##### input - -###### config - -`TConfig` - -###### prefix? - -`string` - -#### Returns - -`Promise`\<`TurnkeyDirectWallet`\> - -*** - -### initWithPublicKey() - -> `static` **initWithPublicKey**(`input`): `TurnkeyDirectWallet` - -Defined in: [cosmjs/src/index.ts:73](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L73) - -#### Parameters - -##### input - -###### config - -`TConfig` - -###### prefix? - -`string` - -#### Returns - -`TurnkeyDirectWallet` diff --git a/generated-docs/sdks/cosmjs/index/TurnkeyRequestError/readme.mdx b/generated-docs/sdks/cosmjs/index/TurnkeyRequestError/readme.mdx deleted file mode 100644 index 0e296410e..000000000 --- a/generated-docs/sdks/cosmjs/index/TurnkeyRequestError/readme.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "TurnkeyRequestError" -mode: wide ---- - -# Class: TurnkeyRequestError - -Defined in: http/dist/base.d.ts:84 - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new TurnkeyRequestError**(`input`): `TurnkeyRequestError` - -Defined in: http/dist/base.d.ts:87 - -#### Parameters - -##### input - -`GrpcStatus` - -#### Returns - -`TurnkeyRequestError` - -#### Overrides - -`Error.constructor` - -## Properties - -### code - -> **code**: `number` - -Defined in: http/dist/base.d.ts:86 - -*** - -### details - -> **details**: `null` \| `any`[] - -Defined in: http/dist/base.d.ts:85 diff --git a/generated-docs/sdks/cosmjs/index/fetchCompressedPublicKey/readme.mdx b/generated-docs/sdks/cosmjs/index/fetchCompressedPublicKey/readme.mdx deleted file mode 100644 index e1d11e0ea..000000000 --- a/generated-docs/sdks/cosmjs/index/fetchCompressedPublicKey/readme.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "FetchCompressedPublicKey" -mode: wide ---- - -# Function: fetchCompressedPublicKey() - -> **fetchCompressedPublicKey**(`input`): `Promise`\<\{ `compressedPublicKey`: `Uint8Array`; \}\> - -Defined in: [cosmjs/src/index.ts:210](https://github.com/tkhq/sdk/blob/main/packages/cosmjs/src/index.ts#L210) - -## Parameters - -### input - -#### client - -`TurnkeyClient` \| [`TurnkeyBrowserClient`](../../../sdk-browser/index/TurnkeyBrowserClient/readme) \| [`TurnkeyServerClient`](../../../sdk-server/index/TurnkeyServerClient/readme) - -#### organizationId - -`string` - -#### privateKeyId - -`string` - -## Returns - -`Promise`\<\{ `compressedPublicKey`: `Uint8Array`; \}\> diff --git a/generated-docs/sdks/cosmjs/index/readme.mdx b/generated-docs/sdks/cosmjs/index/readme.mdx deleted file mode 100644 index d48045185..000000000 --- a/generated-docs/sdks/cosmjs/index/readme.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Classes - -- [TurnkeyActivityError](TurnkeyActivityError/readme) -- [TurnkeyDirectWallet](TurnkeyDirectWallet/readme) -- [TurnkeyRequestError](TurnkeyRequestError/readme) - -## Functions - -- [fetchCompressedPublicKey](fetchCompressedPublicKey/readme) diff --git a/generated-docs/sdks/cosmjs/readme.mdx b/generated-docs/sdks/cosmjs/readme.mdx deleted file mode 100644 index 67edf369a..000000000 --- a/generated-docs/sdks/cosmjs/readme.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: "Cosmjs" -mode: wide ---- - -# @turnkey/cosmjs - -[![npm](https://img.shields.io/npm/v/@turnkey/cosmjs?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/cosmjs) - -Experimental [Turnkey](https://turnkey.com) Cosmos Signer for [`CosmJS`](https://github.com/cosmos/cosmjs): - -- `TurnkeyDirectWallet` is a drop-in replacement for [`DirectSecp256k1Wallet`](https://github.com/cosmos/cosmjs/blob/e8e65aa0c145616ccb58625c32bffe08b46ff574/packages/proto-signing/src/directsecp256k1wallet.ts#LL14C14-L14C35) that conforms to the `OfflineDirectSigner` interface. - -If you need a lower-level, fully typed HTTP client for interacting with Turnkey API, check out [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http). - -API Docs: https://docs.turnkey.com/ - -## Getting started - -```bash -$ npm install @turnkey/cosmjs -``` - -## Examples - -| Example | Description | -| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| [`with-cosmjs`](https://github.com/tkhq/sdk/tree/main/examples/with-cosmjs) | Create a new Cosmos address, then sign and broadcast a transaction on Celestia testnet via CosmJS | - -## See also - -- [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http): lower-level fully typed HTTP client for interacting with Turnkey API - -## Documents - -- [documents/docs](documents/docs/readme) - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/crypto/index/buildAdditionalAssociatedData/readme.mdx b/generated-docs/sdks/crypto/index/buildAdditionalAssociatedData/readme.mdx deleted file mode 100644 index c6c8fabe2..000000000 --- a/generated-docs/sdks/crypto/index/buildAdditionalAssociatedData/readme.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "BuildAdditionalAssociatedData" -mode: wide ---- - -# Function: buildAdditionalAssociatedData() - -> **buildAdditionalAssociatedData**(`senderPubBuf`, `receiverPubBuf`): `Uint8Array` - -Defined in: [crypto.ts:294](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L294) - -Create additional associated data (AAD) for AES-GCM decryption. - -## Parameters - -### senderPubBuf - -`Uint8Array` - -### receiverPubBuf - -`Uint8Array` - -## Returns - -`Uint8Array` - -- The resulting concatenation of sender and receiver pubkeys. diff --git a/generated-docs/sdks/crypto/index/compressRawPublicKey/readme.mdx b/generated-docs/sdks/crypto/index/compressRawPublicKey/readme.mdx deleted file mode 100644 index 687c9e4b5..000000000 --- a/generated-docs/sdks/crypto/index/compressRawPublicKey/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "CompressRawPublicKey" -mode: wide ---- - -# Function: compressRawPublicKey() - -> **compressRawPublicKey**(`rawPublicKey`): `Uint8Array` - -Defined in: [crypto.ts:322](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L322) - -Accepts a public key Uint8Array, and returns a Uint8Array with the compressed version of the public key. - -## Parameters - -### rawPublicKey - -`Uint8Array` - -The raw public key. - -## Returns - -`Uint8Array` - -– The compressed public key. diff --git a/generated-docs/sdks/crypto/index/decryptCredentialBundle/readme.mdx b/generated-docs/sdks/crypto/index/decryptCredentialBundle/readme.mdx deleted file mode 100644 index 283129b85..000000000 --- a/generated-docs/sdks/crypto/index/decryptCredentialBundle/readme.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "DecryptCredentialBundle" -mode: wide ---- - -# Function: decryptCredentialBundle() - -> **decryptCredentialBundle**(`credentialBundle`, `embeddedKey`): `string` - -Defined in: [turnkey.ts:59](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/turnkey.ts#L59) - -Decrypt an encrypted email auth/recovery or oauth credential bundle. - -## Parameters - -### credentialBundle - -`string` - -The encrypted credential bundle. - -### embeddedKey - -`string` - -The private key for decryption. - -## Returns - -`string` - -- The decrypted data or null if decryption fails. - -## Throws - -- If unable to decrypt the credential bundle diff --git a/generated-docs/sdks/crypto/index/decryptExportBundle/readme.mdx b/generated-docs/sdks/crypto/index/decryptExportBundle/readme.mdx deleted file mode 100644 index b5ac5a20a..000000000 --- a/generated-docs/sdks/crypto/index/decryptExportBundle/readme.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "DecryptExportBundle" -mode: wide ---- - -# Function: decryptExportBundle() - -> **decryptExportBundle**(`params`): `Promise`\<`string`\> - -Defined in: [turnkey.ts:103](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/turnkey.ts#L103) - -Decrypt an encrypted export bundle (such as a private key or wallet account bundle). - -This function verifies the enclave signature to ensure the authenticity of the encrypted data. -It uses HPKE (Hybrid Public Key Encryption) to decrypt the contents of the bundle and returns -either the decrypted mnemonic or the decrypted data in hexadecimal format, based on the -`returnMnemonic` flag. - -## Parameters - -### params - -`DecryptExportBundleParams` - -An object containing the following properties: - - exportBundle {string}: The encrypted export bundle in JSON format. - - organizationId {string}: The expected organization ID to verify against the signed data. - - embeddedKey {string}: The private key used for decrypting the data. - - dangerouslyOverrideSignerPublicKey {string} [Optional]: Optionally override the default signer public key used for verifying the signature. This should only be done for testing - - returnMnemonic {boolean}: If true, returns the decrypted data as a mnemonic string; otherwise, returns it in hexadecimal format. - -## Returns - -`Promise`\<`string`\> - -- A promise that resolves to the decrypted mnemonic or decrypted hexadecimal data. - -## Throws - -- If decryption or signature verification fails, throws an error with details. diff --git a/generated-docs/sdks/crypto/index/encryptPrivateKeyToBundle/readme.mdx b/generated-docs/sdks/crypto/index/encryptPrivateKeyToBundle/readme.mdx deleted file mode 100644 index eea1dd1b6..000000000 --- a/generated-docs/sdks/crypto/index/encryptPrivateKeyToBundle/readme.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "EncryptPrivateKeyToBundle" -mode: wide ---- - -# Function: encryptPrivateKeyToBundle() - -> **encryptPrivateKeyToBundle**(`params`): `Promise`\<`string`\> - -Defined in: [turnkey.ts:304](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/turnkey.ts#L304) - -Encrypts a private key bundle using HPKE and verifies the enclave signature. - -## Parameters - -### params - -`EncryptPrivateKeyToBundleParams` - -An object containing the private key, key format, bundle, user, and organization details. Optionally, you can override the default signer key (for testing purposes) - -## Returns - -`Promise`\<`string`\> - -- A promise that resolves to a JSON string representing the encrypted bundle. - -## Throws - -- If enclave signature verification or any other validation fails. diff --git a/generated-docs/sdks/crypto/index/encryptWalletToBundle/readme.mdx b/generated-docs/sdks/crypto/index/encryptWalletToBundle/readme.mdx deleted file mode 100644 index 9ed347a05..000000000 --- a/generated-docs/sdks/crypto/index/encryptWalletToBundle/readme.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "EncryptWalletToBundle" -mode: wide ---- - -# Function: encryptWalletToBundle() - -> **encryptWalletToBundle**(`params`): `Promise`\<`string`\> - -Defined in: [turnkey.ts:360](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/turnkey.ts#L360) - -/** - * Encrypts a mnemonic wallet bundle using HPKE and verifies the enclave signature. - * - * - -## Parameters - -### params - -`EncryptWalletToBundleParams` - -An object containing the mnemonic, bundle, user, and organization details. Optionally, you can override the default signer key (for testing purposes). - * - -## Returns - -`Promise`\<`string`\> - -- A promise that resolves to a JSON string representing the encrypted wallet bundle. - * - -## Throws - -- If enclave signature verification or any other validation fails. diff --git a/generated-docs/sdks/crypto/index/extractPrivateKeyFromPKCS8Bytes/readme.mdx b/generated-docs/sdks/crypto/index/extractPrivateKeyFromPKCS8Bytes/readme.mdx deleted file mode 100644 index 23d2f9fb9..000000000 --- a/generated-docs/sdks/crypto/index/extractPrivateKeyFromPKCS8Bytes/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "ExtractPrivateKeyFromPKCS8Bytes" -mode: wide ---- - -# Function: extractPrivateKeyFromPKCS8Bytes() - -> **extractPrivateKeyFromPKCS8Bytes**(`privateKey`): `Uint8Array` - -Defined in: [crypto.ts:310](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L310) - -Accepts a private key Uint8Array in the PKCS8 format, and returns the encapsulated private key. - -## Parameters - -### privateKey - -`Uint8Array` - -A PKCS#8 private key structured with the key data at a specific position. The actual key starts at byte 36 and is 32 bytes long. - -## Returns - -`Uint8Array` - -- The private key. diff --git a/generated-docs/sdks/crypto/index/formatHpkeBuf/readme.mdx b/generated-docs/sdks/crypto/index/formatHpkeBuf/readme.mdx deleted file mode 100644 index 59c3d847c..000000000 --- a/generated-docs/sdks/crypto/index/formatHpkeBuf/readme.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "FormatHpkeBuf" -mode: wide ---- - -# Function: formatHpkeBuf() - -> **formatHpkeBuf**(`encryptedBuf`): `string` - -Defined in: [crypto.ts:202](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L202) - -Format HPKE Buffer Function -Returns a JSON string of an encrypted bundle, separating out the cipher text and the sender public key - -## Parameters - -### encryptedBuf - -`Uint8Array` - -The result of hpkeAuthEncrypt or hpkeEncrypt - -## Returns - -`string` - -- A JSON string with "encappedPublic" and "ciphertext" diff --git a/generated-docs/sdks/crypto/index/fromDerSignature/readme.mdx b/generated-docs/sdks/crypto/index/fromDerSignature/readme.mdx deleted file mode 100644 index bbe6bee9b..000000000 --- a/generated-docs/sdks/crypto/index/fromDerSignature/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "FromDerSignature" -mode: wide ---- - -# Function: fromDerSignature() - -> **fromDerSignature**(`derSignature`): `Uint8Array` - -Defined in: [crypto.ts:528](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L528) - -Converts an ASN.1 DER-encoded ECDSA signature to the raw format used for verification. - -## Parameters - -### derSignature - -`string` - -The DER-encoded signature. - -## Returns - -`Uint8Array` - -- The raw signature. diff --git a/generated-docs/sdks/crypto/index/generateP256KeyPair/readme.mdx b/generated-docs/sdks/crypto/index/generateP256KeyPair/readme.mdx deleted file mode 100644 index 52203f05f..000000000 --- a/generated-docs/sdks/crypto/index/generateP256KeyPair/readme.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "GenerateP256KeyPair" -mode: wide ---- - -# Function: generateP256KeyPair() - -> **generateP256KeyPair**(): `KeyPair` - -Defined in: [crypto.ts:274](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L274) - -Generate a P-256 key pair. Contains the hexed privateKey, publicKey, and Uncompressed publicKey - -## Returns - -`KeyPair` - -- The generated key pair. diff --git a/generated-docs/sdks/crypto/index/getPublicKey/readme.mdx b/generated-docs/sdks/crypto/index/getPublicKey/readme.mdx deleted file mode 100644 index cb8acab01..000000000 --- a/generated-docs/sdks/crypto/index/getPublicKey/readme.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "GetPublicKey" -mode: wide ---- - -# Function: getPublicKey() - -> **getPublicKey**(`privateKey`, `isCompressed`): `Uint8Array` - -Defined in: [crypto.ts:56](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L56) - -Get PublicKey function -Derives public key from Uint8Array or hexstring private key - -## Parameters - -### privateKey - -The Uint8Array or hexstring representation of a compressed private key. - -`string` | `Uint8Array` - -### isCompressed - -`boolean` = `true` - -Specifies whether to return a compressed or uncompressed public key. Defaults to true. - -## Returns - -`Uint8Array` - -- The public key in Uin8Array representation. diff --git a/generated-docs/sdks/crypto/index/hpkeAuthEncrypt/readme.mdx b/generated-docs/sdks/crypto/index/hpkeAuthEncrypt/readme.mdx deleted file mode 100644 index a0a14264c..000000000 --- a/generated-docs/sdks/crypto/index/hpkeAuthEncrypt/readme.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "HpkeAuthEncrypt" -mode: wide ---- - -# Function: hpkeAuthEncrypt() - -> **hpkeAuthEncrypt**(`params`): `Uint8Array` - -Defined in: [crypto.ts:138](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L138) - -HPKE Encrypt Function -Encrypts data using Authenticated ,Hybrid Public Key Encryption (HPKE) standard https://datatracker.ietf.org/doc/rfc9180/. - -## Parameters - -### params - -`HpkeAuthEncryptParams` - -The encryption parameters including plain text, encapsulated key, and sender private key. - -## Returns - -`Uint8Array` - -- The encrypted data. diff --git a/generated-docs/sdks/crypto/index/hpkeDecrypt/readme.mdx b/generated-docs/sdks/crypto/index/hpkeDecrypt/readme.mdx deleted file mode 100644 index 860600a17..000000000 --- a/generated-docs/sdks/crypto/index/hpkeDecrypt/readme.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "HpkeDecrypt" -mode: wide ---- - -# Function: hpkeDecrypt() - -> **hpkeDecrypt**(`params`): `Uint8Array` - -Defined in: [crypto.ts:224](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L224) - -HPKE Decrypt Function -Decrypts data using Hybrid Public Key Encryption (HPKE) standard https://datatracker.ietf.org/doc/rfc9180/. - -## Parameters - -### params - -`HpkeDecryptParams` - -The decryption parameters including ciphertext, encapsulated key, and receiver private key. - -## Returns - -`Uint8Array` - -- The decrypted data. diff --git a/generated-docs/sdks/crypto/index/hpkeEncrypt/readme.mdx b/generated-docs/sdks/crypto/index/hpkeEncrypt/readme.mdx deleted file mode 100644 index 64de2b3f5..000000000 --- a/generated-docs/sdks/crypto/index/hpkeEncrypt/readme.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "HpkeEncrypt" -mode: wide ---- - -# Function: hpkeEncrypt() - -> **hpkeEncrypt**(`params`): `Uint8Array` - -Defined in: [crypto.ts:71](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L71) - -HPKE Encrypt Function -Encrypts data using Hybrid Public Key Encryption (HPKE) standard https://datatracker.ietf.org/doc/rfc9180/. - -## Parameters - -### params - -`HpkeEncryptParams` - -The encryption parameters including plain text, encapsulated key, and sender private key. - -## Returns - -`Uint8Array` - -- The encrypted data. diff --git a/generated-docs/sdks/crypto/index/readme.mdx b/generated-docs/sdks/crypto/index/readme.mdx deleted file mode 100644 index 02469cccb..000000000 --- a/generated-docs/sdks/crypto/index/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Functions - -- [buildAdditionalAssociatedData](buildAdditionalAssociatedData/readme) -- [compressRawPublicKey](compressRawPublicKey/readme) -- [decryptCredentialBundle](decryptCredentialBundle/readme) -- [decryptExportBundle](decryptExportBundle/readme) -- [encryptPrivateKeyToBundle](encryptPrivateKeyToBundle/readme) -- [encryptWalletToBundle](encryptWalletToBundle/readme) -- [extractPrivateKeyFromPKCS8Bytes](extractPrivateKeyFromPKCS8Bytes/readme) -- [formatHpkeBuf](formatHpkeBuf/readme) -- [fromDerSignature](fromDerSignature/readme) -- [generateP256KeyPair](generateP256KeyPair/readme) -- [getPublicKey](getPublicKey/readme) -- [hpkeAuthEncrypt](hpkeAuthEncrypt/readme) -- [hpkeDecrypt](hpkeDecrypt/readme) -- [hpkeEncrypt](hpkeEncrypt/readme) -- [toDerSignature](toDerSignature/readme) -- [uncompressRawPublicKey](uncompressRawPublicKey/readme) -- [verifyStampSignature](verifyStampSignature/readme) diff --git a/generated-docs/sdks/crypto/index/toDerSignature/readme.mdx b/generated-docs/sdks/crypto/index/toDerSignature/readme.mdx deleted file mode 100644 index e7df3eadb..000000000 --- a/generated-docs/sdks/crypto/index/toDerSignature/readme.mdx +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: "ToDerSignature" -mode: wide ---- - -# Function: toDerSignature() - -> **toDerSignature**(`rawSignature`): `string` - -Defined in: [crypto.ts:584](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L584) - -Converts a raw ECDSA signature to DER-encoded format. - -This function takes a raw ECDSA signature, which is a concatenation of two 32-byte integers (r and s), -and converts it into the DER-encoded format. DER (Distinguished Encoding Rules) is a binary encoding -for data structures described by ASN.1. - -## Parameters - -### rawSignature - -`string` - -The raw signature in hexadecimal string format. - -## Returns - -`string` - -- The DER-encoded signature in hexadecimal string format. - -## Throws - -- Throws an error if the input signature is invalid or if the encoding process fails. - -## Example - -```ts -// Example usage: -const rawSignature = "0x487cdb8a88f2f4044b701cbb116075c4cabe5fe4657a6358b395c0aab70694db3453a8057e442bd1aff0ecabe8a82c831f0edd7f2158b7c1feb3de9b1f20309b1c"; -const derSignature = toDerSignature(rawSignature); -console.log(derSignature); // Outputs the DER-encoded signature as a hex string -// "30440220487cdb8a88f2f4044b701cbb116075c4cabe5fe4657a6358b395c0aab70694db02203453a8057e442bd1aff0ecabe8a82c831f0edd7f2158b7c1feb3de9b1f20309b" -``` diff --git a/generated-docs/sdks/crypto/index/uncompressRawPublicKey/readme.mdx b/generated-docs/sdks/crypto/index/uncompressRawPublicKey/readme.mdx deleted file mode 100644 index 6783bf457..000000000 --- a/generated-docs/sdks/crypto/index/uncompressRawPublicKey/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "UncompressRawPublicKey" -mode: wide ---- - -# Function: uncompressRawPublicKey() - -> **uncompressRawPublicKey**(`rawPublicKey`): `Uint8Array` - -Defined in: [crypto.ts:342](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/crypto.ts#L342) - -Accepts a public key array buffer, and returns a buffer with the uncompressed version of the public key - -## Parameters - -### rawPublicKey - -`Uint8Array` - -The public key. - -## Returns - -`Uint8Array` - -- The uncompressed public key. diff --git a/generated-docs/sdks/crypto/index/verifyStampSignature/readme.mdx b/generated-docs/sdks/crypto/index/verifyStampSignature/readme.mdx deleted file mode 100644 index d3579113e..000000000 --- a/generated-docs/sdks/crypto/index/verifyStampSignature/readme.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: "VerifyStampSignature" -mode: wide ---- - -# Function: verifyStampSignature() - -> **verifyStampSignature**(`publicKey`, `signature`, `signedData`): `Promise`\<`boolean`\> - -Defined in: [turnkey.ts:193](https://github.com/tkhq/sdk/blob/main/packages/crypto/src/turnkey.ts#L193) - -Verifies a signature from a Turnkey stamp using ECDSA and SHA-256. - -## Parameters - -### publicKey - -`string` - -The public key of the authenticator (e.g. WebAuthn or P256 API key). - -### signature - -`string` - -The ECDSA signature in DER format. - -### signedData - -`string` - -The data that was signed (e.g. JSON-stringified Turnkey request body). - -## Returns - -`Promise`\<`boolean`\> - -- Returns true if the signature is valid, otherwise throws an error. - -## Example - -```ts -const stampedRequest = await turnkeyClient.stampGetWhoami(...); -const decodedStampContents = atob(stampedRequest.stamp.stampHeaderValue); -const parsedStampContents = JSON.parse(decodedStampContents); -const signature = parsedStampContents.signature; - -await verifyStampSignature(publicKey, signature, stampedRequest.body) -``` diff --git a/generated-docs/sdks/crypto/readme.mdx b/generated-docs/sdks/crypto/readme.mdx deleted file mode 100644 index 7ffa14a32..000000000 --- a/generated-docs/sdks/crypto/readme.mdx +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: "Crypto" -mode: wide ---- - -# @turnkey/crypto - -This package consolidates some common cryptographic utilities used across our applications, particularly primitives related to keys, encryption, and decryption in a pure JS implementation. For react-native you will need to polyfill our random byte generation by importing [react-native-get-random-values](https://www.npmjs.com/package/react-native-get-random-values) - -Example usage (Hpke E2E): - -``` -const senderKeyPair = generateP256KeyPair(); -const receiverKeyPair = generateP256KeyPair(); - -const receiverPublicKeyUncompressed = uncompressRawPublicKey( - uint8ArrayFromHexString(receiverKeyPair.publicKey), -); - -const plainText = "Hello, this is a secure message!"; -const plainTextBuf = textEncoder.encode(plainText); -const encryptedData = hpkeEncrypt({ - plainTextBuf: plainTextBuf, - encappedKeyBuf: receiverPublicKeyUncompressed, - senderPriv: senderKeyPair.privateKey, -}); - -// Extract the encapsulated key buffer and the ciphertext -const encappedKeyBuf = encryptedData.slice(0, 33); -const ciphertextBuf = encryptedData.slice(33); - -const decryptedData = hpkeDecrypt({ - ciphertextBuf, - encappedKeyBuf: uncompressRawPublicKey(encappedKeyBuf), - receiverPriv: receiverKeyPair.privateKey, -}); - -// Convert decrypted data back to string -const decryptedText = new TextDecoder().decode(decryptedData); -``` - -## Documents - - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/eip-1193-provider/documents/docs/readme.mdx b/generated-docs/sdks/eip-1193-provider/documents/docs/readme.mdx deleted file mode 100644 index ae139397c..000000000 --- a/generated-docs/sdks/eip-1193-provider/documents/docs/readme.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Docs" -mode: wide ---- - -[**Documentation**](../../../readme) - -*** - -[Documentation](../../../modules) / [eip-1193-provider](../../readme) / documents/docs - ---- -title: "EIP 1193" -description: "[`@turnkey/eip-1193-provider`](https://www.npmjs.com/package/@turnkey/eip-1193-provider) is a Turnkey-compatible Ethereum provider that conforms to the [EIP-1193](https://eips.ethereum.org/EIPS/eip-1193) standard. It's built to seamlessly integrate with a broad spectrum of EVM-compatible chains, offering capabilities like account management, transaction signing, and blockchain interaction." -mode: wide ---- - -See [`with-eip-1193-provider`](https://github.com/tkhq/sdk/tree/main/examples/with-eip-1193-provider) for an example. diff --git a/generated-docs/sdks/eip-1193-provider/index/TurnkeyEIP1193Provider/readme.mdx b/generated-docs/sdks/eip-1193-provider/index/TurnkeyEIP1193Provider/readme.mdx deleted file mode 100644 index c1f341ac9..000000000 --- a/generated-docs/sdks/eip-1193-provider/index/TurnkeyEIP1193Provider/readme.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "TurnkeyEIP1193Provider" -mode: wide ---- - -# Type Alias: TurnkeyEIP1193Provider - -> **TurnkeyEIP1193Provider** = `Omit`\<`EIP1193Provider`, `"request"`\> & `object` - -Defined in: [packages/eip-1193-provider/src/types.ts:22](https://github.com/tkhq/sdk/blob/main/packages/eip-1193-provider/src/types.ts#L22) - -## Type declaration - -### request - -> **request**: `EIP1193RequestFn`\<\[`...EIP1474Methods`, \{ `Method`: `"eth_signTypedData_v4"`; `Parameters`: \[`Address`, `TypedDataDefinition`\]; `ReturnType`: `Promise`\<`Hash`\>; \}\]\> diff --git a/generated-docs/sdks/eip-1193-provider/index/createEIP1193Provider/readme.mdx b/generated-docs/sdks/eip-1193-provider/index/createEIP1193Provider/readme.mdx deleted file mode 100644 index 12c8f19c9..000000000 --- a/generated-docs/sdks/eip-1193-provider/index/createEIP1193Provider/readme.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "CreateEIP1193Provider" -mode: wide ---- - -# Function: createEIP1193Provider() - -> **createEIP1193Provider**(`options`): `Promise`\<\{ `on`: (`eventName`, `listener`) => `this`; `removeListener`: (`eventName`, `listener`) => `this`; `request`: `EIP1193RequestFn`\<\[\{\}, \{\}, \{\}, \{\}, \{\}\]\>; \}\> - -Defined in: [packages/eip-1193-provider/src/index.ts:31](https://github.com/tkhq/sdk/blob/main/packages/eip-1193-provider/src/index.ts#L31) - -## Parameters - -### options - -`TurnkeyEIP1193ProviderOptions` - -## Returns - -`Promise`\<\{ `on`: (`eventName`, `listener`) => `this`; `removeListener`: (`eventName`, `listener`) => `this`; `request`: `EIP1193RequestFn`\<\[\{\}, \{\}, \{\}, \{\}, \{\}\]\>; \}\> diff --git a/generated-docs/sdks/eip-1193-provider/index/readme.mdx b/generated-docs/sdks/eip-1193-provider/index/readme.mdx deleted file mode 100644 index 89b9321d4..000000000 --- a/generated-docs/sdks/eip-1193-provider/index/readme.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Type Aliases - -- [TurnkeyEIP1193Provider](TurnkeyEIP1193Provider/readme) - -## Functions - -- [createEIP1193Provider](createEIP1193Provider/readme) diff --git a/generated-docs/sdks/eip-1193-provider/readme.mdx b/generated-docs/sdks/eip-1193-provider/readme.mdx deleted file mode 100644 index 6a5c9a3df..000000000 --- a/generated-docs/sdks/eip-1193-provider/readme.mdx +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: "Eip 1193 Provider" -mode: wide ---- - -# Turnkey EIP-1193 Provider - -The `@turnkey/eip-1193-provider` package delivers a Turnkey-compatible Ethereum provider that adheres to the EIP-1193 standards. It's built to integrate seamlessly with a broad spectrum of EVM-compatible chains, offering capabilities like account management, transaction signing, and blockchain interaction. This initial setup is intended for use in conjunction with the [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http) and [`@turnkey/webauthn-stamper`](https://www.npmjs.com/package/@turnkey/webauthn-stamper) package, for initial authentication. - -## Installation - -Before you start using the Turnkey EIP-1193 Provider, make sure to install the necessary packages in your project. This guide assumes you have a Node.js environment ready for development. - -Install the required packages using NPM or Yarn: - -```bash -npm install @turnkey/eip-1193-provider @turnkey/http @turnkey/webauthn-stamper -``` - -```bash -pnpm add @turnkey/eip-1193-provider @turnkey/http @turnkey/webauthn-stamper -``` - -```bash -yarn add @turnkey/eip-1193-provider @turnkey/http @turnkey/webauthn-stamper -``` - -## Initialization - -To set up the Turnkey EIP-1193 Provider, you need to initialize it with your configuration, which includes setting up the Turnkey client with your base URL and stamper. - -```ts -import { WebauthnStamper } from "@turnkey/webauthn-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -const stamper = new WebauthnStamper({ - rpId: "example.com", -}); - -// Initialize the Turnkey HTTP client -const turnkeyClient = new TurnkeyClient( - { baseUrl: "https://api.turnkey.com" }, - stamper, -); - -// Get the organizationId of the sub-organization connected to the users account -const { organizationId } = await turnkeyClient.getWhoami({ - organizationId: process.env.ORGANIZATION_ID, -}); - -// Get the user wallets associated with their sub-organization -const { wallets } = await turnkeyClient.getWallets({ - organizationId, -}); - -// Get the walletId to connect to the provider -const walletId = wallets[0].walletId; - -const chain = { - chainName: "Ethereum Mainnet", - chainId: "0x1", - rpcUrls: ["https://mainnet.infura.io/v3/your-infura-project-id"], -}; - -// Initialize the EIP-1193 Provider with your configuration -const provider = await createEIP1193Provider({ - walletId, - organizationId, - turnkeyClient, - chains: [ - chain, - // Add more chains as needed - ], -}); -``` - -## Usage - -### `eth_requestAccounts` - -Requests the user to provide an Ethereum address for identification, as specified by [EIP-1102](https://eips.ethereum.org/EIPS/eip-1102). This method initiates connectivity with the client and will prompt for passkey authentication. - -```javascript -const accounts = await provider.request({ method: "eth_requestAccounts" }); -// Logs the array accounts associated with the provided walletId & organization -console.log(accounts); -``` - -### Authentication Prompt Methods - -The following methods also prompt for passkey authentication: - -- `personal_sign`: Signs a message with the specified account. -- `eth_sign`: Signs data with the specified account. -- `eth_signTransaction`: Signs a transaction with the specified account. -- `eth_signTypedData_v4`: Signs typed data according to EIP-712 with the specified account. -- `eth_sendTransaction`: Submits a transaction to the network for execution. - -## Testing (Local) - -1. Copy `.env.example` to `.env` - - ```bash - $ cp .env.example .env - ``` - -2. Start the Anvil node in one shell: - - - Install [Foundry](https://book.getfoundry.sh/getting-started/installation) & Anvil if you haven't done so already - - Add Foundry to your `$PATH` - ```bash - $ export PATH="$PATH:$HOME/.foundry/bin" - ``` - - Source your env e.g. - ```bash - $ source ~/.zshrc - ``` - - Run `foundryup` to install `Anvil` - ```bash - $ foundryup - ``` - - Start Anvil - ``` - $ pnpm anvil - ``` - -3. Run the tests in a new shell: - - ``` - $ pnpm test - ``` - -## Contributing - -We welcome contributions to improve the `Turnkey EIP-1193 Provider`. Please follow the project's [contribution guidelines](https://github.com/tkhq/sdk/blob/ad9071716919d062ba67fd623a01cbd4523ed444/CONTRIBUTING.md). - -## License - -This project is licensed under [LICENSE](../_media/LICENSE), with detailed information available in the repository. - -## Documents - -- [documents/docs](documents/docs/readme) - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/encoding/index/DEFAULT_JWK_MEMBER_BYTE_LENGTH/readme.mdx b/generated-docs/sdks/encoding/index/DEFAULT_JWK_MEMBER_BYTE_LENGTH/readme.mdx deleted file mode 100644 index 722ed8239..000000000 --- a/generated-docs/sdks/encoding/index/DEFAULT_JWK_MEMBER_BYTE_LENGTH/readme.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "DEFAULT_JWK_MEMBER_BYTE_LENGTH" -mode: wide ---- - -# Variable: DEFAULT\_JWK\_MEMBER\_BYTE\_LENGTH - -> `const` **DEFAULT\_JWK\_MEMBER\_BYTE\_LENGTH**: `32` = `32` - -Defined in: [index.ts:4](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L4) - -Code modified from https://github.com/github/webauthn-json/blob/e932b3585fa70b0bd5b5a4012ba7dbad7b0a0d0f/src/webauthn-json/base64url.ts#L23 diff --git a/generated-docs/sdks/encoding/index/base64StringToBase64UrlEncodedString/readme.mdx b/generated-docs/sdks/encoding/index/base64StringToBase64UrlEncodedString/readme.mdx deleted file mode 100644 index 54f49dc1a..000000000 --- a/generated-docs/sdks/encoding/index/base64StringToBase64UrlEncodedString/readme.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Base64StringToBase64UrlEncodedString" -mode: wide ---- - -# Function: base64StringToBase64UrlEncodedString() - -> **base64StringToBase64UrlEncodedString**(`input`): `string` - -Defined in: [index.ts:23](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L23) - -## Parameters - -### input - -`string` - -## Returns - -`string` diff --git a/generated-docs/sdks/encoding/index/hexStringToBase64url/readme.mdx b/generated-docs/sdks/encoding/index/hexStringToBase64url/readme.mdx deleted file mode 100644 index 455b27483..000000000 --- a/generated-docs/sdks/encoding/index/hexStringToBase64url/readme.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "HexStringToBase64url" -mode: wide ---- - -# Function: hexStringToBase64url() - -> **hexStringToBase64url**(`input`, `length`?): `string` - -Defined in: [index.ts:12](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L12) - -## Parameters - -### input - -`string` - -### length? - -`number` - -## Returns - -`string` diff --git a/generated-docs/sdks/encoding/index/hexToAscii/readme.mdx b/generated-docs/sdks/encoding/index/hexToAscii/readme.mdx deleted file mode 100644 index c039ec34a..000000000 --- a/generated-docs/sdks/encoding/index/hexToAscii/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "HexToAscii" -mode: wide ---- - -# Function: hexToAscii() - -> **hexToAscii**(`hexString`): `string` - -Defined in: [index.ts:69](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L69) - -Converts a hex string to an ASCII string. - -## Parameters - -### hexString - -`string` - -The input hex string to convert. - -## Returns - -`string` - -- The converted ASCII string. diff --git a/generated-docs/sdks/encoding/index/normalizePadding/readme.mdx b/generated-docs/sdks/encoding/index/normalizePadding/readme.mdx deleted file mode 100644 index 1e8964c81..000000000 --- a/generated-docs/sdks/encoding/index/normalizePadding/readme.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "NormalizePadding" -mode: wide ---- - -# Function: normalizePadding() - -> **normalizePadding**(`byteArray`, `targetLength`): `Uint8Array` - -Defined in: [index.ts:84](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L84) - -Function to normalize padding of byte array with 0's to a target length. - -## Parameters - -### byteArray - -`Uint8Array` - -The byte array to pad or trim. - -### targetLength - -`number` - -The target length after padding or trimming. - -## Returns - -`Uint8Array` - -- The normalized byte array. diff --git a/generated-docs/sdks/encoding/index/readme.mdx b/generated-docs/sdks/encoding/index/readme.mdx deleted file mode 100644 index 961cad5c3..000000000 --- a/generated-docs/sdks/encoding/index/readme.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Variables - -- [DEFAULT\_JWK\_MEMBER\_BYTE\_LENGTH](DEFAULT_JWK_MEMBER_BYTE_LENGTH/readme) - -## Functions - -- [base64StringToBase64UrlEncodedString](base64StringToBase64UrlEncodedString/readme) -- [hexStringToBase64url](hexStringToBase64url/readme) -- [hexToAscii](hexToAscii/readme) -- [normalizePadding](normalizePadding/readme) -- [stringToBase64urlString](stringToBase64urlString/readme) -- [uint8ArrayFromHexString](uint8ArrayFromHexString/readme) -- [uint8ArrayToHexString](uint8ArrayToHexString/readme) diff --git a/generated-docs/sdks/encoding/index/stringToBase64urlString/readme.mdx b/generated-docs/sdks/encoding/index/stringToBase64urlString/readme.mdx deleted file mode 100644 index 52f380ede..000000000 --- a/generated-docs/sdks/encoding/index/stringToBase64urlString/readme.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "StringToBase64urlString" -mode: wide ---- - -# Function: stringToBase64urlString() - -> **stringToBase64urlString**(`input`): `string` - -Defined in: [index.ts:6](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L6) - -## Parameters - -### input - -`string` - -## Returns - -`string` diff --git a/generated-docs/sdks/encoding/index/uint8ArrayFromHexString/readme.mdx b/generated-docs/sdks/encoding/index/uint8ArrayFromHexString/readme.mdx deleted file mode 100644 index d42820cf5..000000000 --- a/generated-docs/sdks/encoding/index/uint8ArrayFromHexString/readme.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Uint8ArrayFromHexString" -mode: wide ---- - -# Function: uint8ArrayFromHexString() - -> **uint8ArrayFromHexString**(`hexString`, `length`?): `Uint8Array` - -Defined in: [index.ts:34](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L34) - -## Parameters - -### hexString - -`string` - -### length? - -`number` - -## Returns - -`Uint8Array` diff --git a/generated-docs/sdks/encoding/index/uint8ArrayToHexString/readme.mdx b/generated-docs/sdks/encoding/index/uint8ArrayToHexString/readme.mdx deleted file mode 100644 index 7dea17e4d..000000000 --- a/generated-docs/sdks/encoding/index/uint8ArrayToHexString/readme.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "Uint8ArrayToHexString" -mode: wide ---- - -# Function: uint8ArrayToHexString() - -> **uint8ArrayToHexString**(`input`): `string` - -Defined in: [index.ts:27](https://github.com/tkhq/sdk/blob/main/packages/encoding/src/index.ts#L27) - -## Parameters - -### input - -`Uint8Array` - -## Returns - -`string` diff --git a/generated-docs/sdks/encoding/readme.mdx b/generated-docs/sdks/encoding/readme.mdx deleted file mode 100644 index 16f769267..000000000 --- a/generated-docs/sdks/encoding/readme.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Encoding" -mode: wide ---- - -# @turnkey/encoding - -This is a package containing decoding and encoding functions. This is used by other Turnkey packages. Feel free to import exported functions into your own apps, but be aware that there may be significant interface changes in the future. - -## Documents - - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/ethers/documents/docs/readme.mdx b/generated-docs/sdks/ethers/documents/docs/readme.mdx deleted file mode 100644 index d66b439d1..000000000 --- a/generated-docs/sdks/ethers/documents/docs/readme.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Docs" -mode: wide ---- - -[**Documentation**](../../../readme) - -*** - -[Documentation](../../../modules) / [ethers](../../readme) / documents/docs - ---- -title: "Ethers" -description: "[`@turnkey/ethers`](https://www.npmjs.com/package/@turnkey/ethers) exports a `TurnkeySigner` that serves as a drop-in replacement for an Ethers signer." -mode: wide ---- - -Out of the box, it supports `{ signTransaction | signMessage | signTypedData }`. See full implementation [here](https://github.com/tkhq/sdk/tree/main/packages/ethers) for more details and examples. Note that you must **bring your own provider and connect it** to the TurnkeySigner. - -```js -// Initialize a Turnkey Signer -const turnkeySigner = new TurnkeySigner({ - ... -}); - -// Bring your own provider (such as Alchemy or Infura: https://docs.ethers.org/v6/api/providers/) -const network = "goerli"; -const provider = new ethers.providers.InfuraProvider(network); -const connectedSigner = turnkeySigner.connect(provider); -``` diff --git a/generated-docs/sdks/ethers/index/TurnkeyActivityError/readme.mdx b/generated-docs/sdks/ethers/index/TurnkeyActivityError/readme.mdx deleted file mode 100644 index 8a69180c1..000000000 --- a/generated-docs/sdks/ethers/index/TurnkeyActivityError/readme.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "TurnkeyActivityError" -mode: wide ---- - -# Class: TurnkeyActivityError - -Defined in: http/dist/shared.d.ts:9 - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new TurnkeyActivityError**(`input`): `TurnkeyActivityError` - -Defined in: http/dist/shared.d.ts:14 - -#### Parameters - -##### input - -###### activityId? - -`string` - -###### activityStatus? - -`"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -###### activityType? - -`"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -###### cause? - -`Error` - -###### message - -`string` - -#### Returns - -`TurnkeyActivityError` - -#### Overrides - -`Error.constructor` - -## Properties - -### activityId - -> **activityId**: `undefined` \| `string` - -Defined in: http/dist/shared.d.ts:10 - -*** - -### activityStatus - -> **activityStatus**: `undefined` \| `"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -Defined in: http/dist/shared.d.ts:11 - -*** - -### activityType - -> **activityType**: `undefined` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -Defined in: http/dist/shared.d.ts:12 - -*** - -### cause - -> **cause**: `undefined` \| `Error` - -Defined in: http/dist/shared.d.ts:13 diff --git a/generated-docs/sdks/ethers/index/TurnkeyRequestError/readme.mdx b/generated-docs/sdks/ethers/index/TurnkeyRequestError/readme.mdx deleted file mode 100644 index 0e296410e..000000000 --- a/generated-docs/sdks/ethers/index/TurnkeyRequestError/readme.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "TurnkeyRequestError" -mode: wide ---- - -# Class: TurnkeyRequestError - -Defined in: http/dist/base.d.ts:84 - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new TurnkeyRequestError**(`input`): `TurnkeyRequestError` - -Defined in: http/dist/base.d.ts:87 - -#### Parameters - -##### input - -`GrpcStatus` - -#### Returns - -`TurnkeyRequestError` - -#### Overrides - -`Error.constructor` - -## Properties - -### code - -> **code**: `number` - -Defined in: http/dist/base.d.ts:86 - -*** - -### details - -> **details**: `null` \| `any`[] - -Defined in: http/dist/base.d.ts:85 diff --git a/generated-docs/sdks/ethers/index/TurnkeySigner/readme.mdx b/generated-docs/sdks/ethers/index/TurnkeySigner/readme.mdx deleted file mode 100644 index ddb52e527..000000000 --- a/generated-docs/sdks/ethers/index/TurnkeySigner/readme.mdx +++ /dev/null @@ -1,259 +0,0 @@ ---- -title: "TurnkeySigner" -mode: wide ---- - -# Class: TurnkeySigner - -Defined in: [ethers/src/index.ts:46](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L46) - -## Extends - -- `AbstractSigner` - -## Implements - -- `Signer` - -## Constructors - -### Constructor - -> **new TurnkeySigner**(`config`, `provider`?): `TurnkeySigner` - -Defined in: [ethers/src/index.ts:55](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L55) - -#### Parameters - -##### config - -`TConfig` - -##### provider? - -`Provider` - -#### Returns - -`TurnkeySigner` - -#### Overrides - -`AbstractSigner.constructor` - -## Properties - -### \_signTypedData() - -> **\_signTypedData**: (`domain`, `types`, `value`) => `Promise`\<`string`\> - -Defined in: [ethers/src/index.ts:297](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L297) - -#### Parameters - -##### domain - -`TypedDataDomain` - -##### types - -`Record`\<`string`, `TypedDataField`[]\> - -##### value - -`Record`\<`string`, `any`\> - -#### Returns - -`Promise`\<`string`\> - -*** - -### organizationId - -> `readonly` **organizationId**: `string` - -Defined in: [ethers/src/index.ts:52](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L52) - -*** - -### signWith - -> `readonly` **signWith**: `string` - -Defined in: [ethers/src/index.ts:53](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L53) - -## Methods - -### \_signMessageImpl() - -> **\_signMessageImpl**(`message`): `Promise`\<`string`\> - -Defined in: [ethers/src/index.ts:234](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L234) - -#### Parameters - -##### message - -`string` - -#### Returns - -`Promise`\<`string`\> - -*** - -### \_signMessageWithErrorWrapping() - -> **\_signMessageWithErrorWrapping**(`message`): `Promise`\<`string`\> - -Defined in: [ethers/src/index.ts:213](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L213) - -#### Parameters - -##### message - -`string` - -#### Returns - -`Promise`\<`string`\> - -*** - -### connect() - -> **connect**(`provider`): `TurnkeySigner` - -Defined in: [ethers/src/index.ts:63](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L63) - -Returns the signer connected to %%provider%%. - - This may throw, for example, a Signer connected over a Socket or - to a specific instance of a node may not be transferrable. - -#### Parameters - -##### provider - -`Provider` - -#### Returns - -`TurnkeySigner` - -#### Implementation of - -`ethers.Signer.connect` - -#### Overrides - -`AbstractSigner.connect` - -*** - -### getAddress() - -> **getAddress**(): `Promise`\<`string`\> - -Defined in: [ethers/src/index.ts:77](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L77) - -Resolves to the Signer address. - -#### Returns - -`Promise`\<`string`\> - -#### Implementation of - -`ethers.Signer.getAddress` - -#### Overrides - -`AbstractSigner.getAddress` - -*** - -### signMessage() - -> **signMessage**(`message`): `Promise`\<`string`\> - -Defined in: [ethers/src/index.ts:206](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L206) - -#### Parameters - -##### message - -`string` | `Uint8Array` - -#### Returns - -`Promise`\<`string`\> - -#### Implementation of - -`ethers.Signer.signMessage` - -#### Overrides - -`AbstractSigner.signMessage` - -*** - -### signTransaction() - -> **signTransaction**(`transaction`): `Promise`\<`string`\> - -Defined in: [ethers/src/index.ts:166](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L166) - -#### Parameters - -##### transaction - -`TransactionRequest` - -#### Returns - -`Promise`\<`string`\> - -#### Implementation of - -`ethers.Signer.signTransaction` - -#### Overrides - -`AbstractSigner.signTransaction` - -*** - -### signTypedData() - -> **signTypedData**(`domain`, `types`, `value`): `Promise`\<`string`\> - -Defined in: [ethers/src/index.ts:273](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L273) - -#### Parameters - -##### domain - -`TypedDataDomain` - -##### types - -`Record`\<`string`, `TypedDataField`[]\> - -##### value - -`Record`\<`string`, `any`\> - -#### Returns - -`Promise`\<`string`\> - -#### Implementation of - -`ethers.Signer.signTypedData` - -#### Overrides - -`AbstractSigner.signTypedData` diff --git a/generated-docs/sdks/ethers/index/readme.mdx b/generated-docs/sdks/ethers/index/readme.mdx deleted file mode 100644 index a7baa9791..000000000 --- a/generated-docs/sdks/ethers/index/readme.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Classes - -- [TurnkeyActivityError](TurnkeyActivityError/readme) -- [TurnkeyRequestError](TurnkeyRequestError/readme) -- [TurnkeySigner](TurnkeySigner/readme) - -## Functions - -- [serializeSignature](serializeSignature/readme) diff --git a/generated-docs/sdks/ethers/index/serializeSignature/readme.mdx b/generated-docs/sdks/ethers/index/serializeSignature/readme.mdx deleted file mode 100644 index a1c7d1cd3..000000000 --- a/generated-docs/sdks/ethers/index/serializeSignature/readme.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "SerializeSignature" -mode: wide ---- - -# Function: serializeSignature() - -> **serializeSignature**(`signature`): `string` - -Defined in: [ethers/src/index.ts:300](https://github.com/tkhq/sdk/blob/main/packages/ethers/src/index.ts#L300) - -## Parameters - -### signature - -## Returns - -`string` diff --git a/generated-docs/sdks/ethers/readme.mdx b/generated-docs/sdks/ethers/readme.mdx deleted file mode 100644 index ae0086394..000000000 --- a/generated-docs/sdks/ethers/readme.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "Ethers" -mode: wide ---- - -# @turnkey/ethers - -[![npm](https://img.shields.io/npm/v/@turnkey/ethers?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/ethers) - -[Turnkey](https://turnkey.com) Signer for [`Ethers`](https://docs.ethers.org/v6/api/providers/#Signer). - -If you need a lower-level, fully typed HTTP client for interacting with Turnkey API, check out [`@turnkey/http`](/packages/http/). - -API Docs: https://docs.turnkey.com/ - -## Getting started - -```bash -$ npm install ethers @turnkey/ethers -``` - -```typescript -import { ethers } from "ethers"; -import { TurnkeySigner } from "@turnkey/ethers"; -import { TurnkeyClient } from "@turnkey/http"; -import { ApiKeyStamper } from "@turnkey/api-key-stamper"; - -async function main() { - const network = "goerli"; - const provider = new ethers.providers.InfuraProvider(network); - - const turnkeyClient = 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: "...", - }), - ); - - // Initialize a Turnkey Signer - const turnkeySigner = new TurnkeySigner({ - client: turnkeyClient, - organizationId: "...", - signWith: "...", - }); - - // Connect it with a Provider (https://docs.ethers.org/v6/api/providers/) - const connectedSigner = turnkeySigner.connect(provider); - - const chainId = await connectedSigner.getChainId(); - const address = await connectedSigner.getAddress(); - const balance = await connectedSigner.getBalance(); - const transactionCount = await connectedSigner.getTransactionCount(); - - console.log(`Network\n\t${network} (chain ID ${chainId})`); - console.log(`Address\n\t${address}`); - console.log(`Balance\n\t${String(balance)}`); - console.log(`Transaction count\n\t${transactionCount}`); - - const transactionRequest = { - to: "0x2Ad9eA1E677949a536A270CEC812D6e868C88108", - value: ethers.utils.parseEther("0.0001"), - type: 2, - }; - - const signedTx = await connectedSigner.signTransaction(transactionRequest); - - console.log(`Signed transaction\n\t${signedTx}`); - - if (balance.isZero()) { - let warningMessage = - "\nWarning: the transaction won't be broadcasted because your account balance is zero.\n"; - if (network === "goerli") { - warningMessage += - "Use https://goerlifaucet.com/ to request funds on Goerli, then run the script again.\n"; - } - - console.warn(warningMessage); - return; - } - - const sentTx = await connectedSigner.sendTransaction(transactionRequest); - - console.log( - `Transaction sent!\n\thttps://${network}.etherscan.io/tx/${sentTx.hash}`, - ); -} - -main().catch((error) => { - console.error(error); - process.exit(1); -}); -``` - -## Testing (Local) - -See `.env.example` to get your local testing environment right. Run `pnpm jest` to run the tests. - -## More examples - -| Example | Description | -| ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -| [`with-ethers`](/examples/with-ethers/) | Create a new Ethereum address, then sign and broadcast a transaction using the Ethers signer with Infura | -| [`with-gnosis`](/examples/with-gnosis/) | Create new Ethereum addresses, configure a 3/3 Gnosis safe, and create + execute a transaction from it | -| [`with-uniswap`](/examples/with-uniswap/) | Sign and broadcast a Uniswap v3 trade using the Ethers signer with Infura | -| [`with-nonce-manager`](/examples/with-nonce-manager/) | Create a new Ethereum address, then sign and broadcast multiple transactions in a sequential or optimistic manner. | -| [`sweeper`](/examples/sweeper/) | Sweep funds from one address to a different address | -| [`deployer`](/examples/deployer/) | Compile and deploy a smart contract | - -## See also - -- [`@turnkey/http`](/packages/http/): lower-level fully typed HTTP client for interacting with Turnkey API - -## Documents - -- [documents/docs](documents/docs/readme) - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/http/TurnkeyClient/readme.mdx b/generated-docs/sdks/http/TurnkeyClient/readme.mdx deleted file mode 100644 index ed81e711c..000000000 --- a/generated-docs/sdks/http/TurnkeyClient/readme.mdx +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: "TurnkeyClient" -mode: wide ---- - -## Introduction - -The [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http) package is a fully-typed lower-level HTTP client for developers integrating with Turnkey. - -## Installing - -To get started install the [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http) client. - - - -```bash npm -npm i @turnkey/http -``` - -```bash pnpm -pnpm i @turnkey/http -``` - -```bash yarn -yarn add @turnkey/http -``` - - - -## Initializing - -Create a new client for use in your JavaScript/Typescript applications. - -You can initialize a new **`TurnkeyClient`** using the **`TurnkeyClient`** constructor. The **`TurnkeyClient`** serves as your entry point to interact with the Turnkey API. - -### Parameters - - - -An object containing configuration settings for the client. - - - - - -The base URL for the Turnkey API. Note: An error `Missing base URL. Please verify env vars.` will be thrown if a value is not provided. - - - - - -An instance of a stamper class (e.g. [**`ApiKeyStamper`**](/sdks/advanced/api-key-stamper)) used to create signatures for authenticating API requests. - -Currently Turnkey provides 3 stampers: - -- applications signing requests with Passkeys or webauthn devices should use [`@turnkey/webauthn-stamper`](/sdks/advanced/webauthn-stamper) -- applications signing requests with API keys should use [`@turnkey/api-key-stamper`](/sdks/advanced/api-key-stamper) -- applications that need to sign requests within an iframe, particularly when handling sensitive operations like Auth, or Key or Wallet Export, should use the [`@turnkey/iframe-stamper`](/sdks/advanced/iframe-stamper). - -You can also implement the TStamper interface yourself. For more information on implementing a custom stamper checkout the [API Design](/developer-reference/api-overview/intro) docs. - -### Types - -#### `THttpConfig` - -```bash -type THttpConfig = { - baseUrl: string; -}; -``` - -#### `TStamper` - -```bash -interface TStamper { - stamp: (input: string) => Promise; -} -``` - -### Example - -```js -import { TurnkeyClient } from "@turnkey/http"; -import { ApiKeyStamper } from "@turnkey/api-key-stamper"; - -// Following best practices, define parameters in your .env file -const baseUrl = process.env.TURNKEY_BASE_URL || "https://api.turnkey.com"; -const apiPublicKey = process.env.TURNKEY_API_PUBLIC_KEY; -const apiPrivateKey = process.env.TURNKEY_API_PRIVATE_KEY; - -// Initialize the API key stamper -const stamper = new ApiKeyStamper({ apiPublicKey, apiPrivateKey }); - -// Initialize the Turnkey client and then you're ready to use the Turnkey client! 🎉 -const client = new TurnkeyClient({ baseUrl }, stamper); -``` diff --git a/generated-docs/sdks/http/index/InvalidArgumentError/readme.mdx b/generated-docs/sdks/http/index/InvalidArgumentError/readme.mdx deleted file mode 100644 index 2164bb92a..000000000 --- a/generated-docs/sdks/http/index/InvalidArgumentError/readme.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "InvalidArgumentError" -mode: wide ---- - -# Class: InvalidArgumentError - -Defined in: [shared.ts:60](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L60) - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new InvalidArgumentError**(`input`): `InvalidArgumentError` - -Defined in: [shared.ts:66](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L66) - -#### Parameters - -##### input - -###### activityId? - -`string` - -###### activityStatus? - -`"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -###### activityType? - -`"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -###### cause? - -`Error` - -###### message - -`string` - -#### Returns - -`InvalidArgumentError` - -#### Overrides - -`Error.constructor` - -## Properties - -### activityId - -> **activityId**: `undefined` \| `string` - -Defined in: [shared.ts:61](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L61) - -*** - -### activityStatus - -> **activityStatus**: `undefined` \| `"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -Defined in: [shared.ts:62](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L62) - -*** - -### activityType - -> **activityType**: `undefined` \| `"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -Defined in: [shared.ts:63](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L63) - -*** - -### cause - -> **cause**: `undefined` \| `Error` - -Defined in: [shared.ts:64](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L64) diff --git a/generated-docs/sdks/http/index/SignedRequest/readme.mdx b/generated-docs/sdks/http/index/SignedRequest/readme.mdx deleted file mode 100644 index 8b1a0b06b..000000000 --- a/generated-docs/sdks/http/index/SignedRequest/readme.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "SignedRequest" -mode: wide ---- - -# Type Alias: ~~SignedRequest~~ - -> **SignedRequest** = `object` - -Defined in: [base.ts:29](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L29) - -Represents a signed request ready to be POSTed to Turnkey - -## Deprecated - -use [TSignedRequest](../TSignedRequest/readme) instead - -## Properties - -### ~~body~~ - -> **body**: `string` - -Defined in: [base.ts:30](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L30) - -*** - -### ~~stamp~~ - -> **stamp**: `string` - -Defined in: [base.ts:31](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L31) - -*** - -### ~~url~~ - -> **url**: `string` - -Defined in: [base.ts:32](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L32) diff --git a/generated-docs/sdks/http/index/TActivity/readme.mdx b/generated-docs/sdks/http/index/TActivity/readme.mdx deleted file mode 100644 index d2bbee05f..000000000 --- a/generated-docs/sdks/http/index/TActivity/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "TActivity" -mode: wide ---- - -# Type Alias: TActivity - -> **TActivity** = `definitions`\[`"v1Activity"`\] - -Defined in: [shared.ts:3](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L3) diff --git a/generated-docs/sdks/http/index/TActivityId/readme.mdx b/generated-docs/sdks/http/index/TActivityId/readme.mdx deleted file mode 100644 index 7fd19d099..000000000 --- a/generated-docs/sdks/http/index/TActivityId/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "TActivityId" -mode: wide ---- - -# Type Alias: TActivityId - -> **TActivityId** = [`TActivity`](../TActivity/readme)\[`"id"`\] - -Defined in: [shared.ts:5](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L5) diff --git a/generated-docs/sdks/http/index/TActivityResponse/readme.mdx b/generated-docs/sdks/http/index/TActivityResponse/readme.mdx deleted file mode 100644 index ce3836301..000000000 --- a/generated-docs/sdks/http/index/TActivityResponse/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "TActivityResponse" -mode: wide ---- - -# Type Alias: TActivityResponse - -> **TActivityResponse** = `definitions`\[`"v1ActivityResponse"`\] - -Defined in: [shared.ts:4](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L4) diff --git a/generated-docs/sdks/http/index/TActivityStatus/readme.mdx b/generated-docs/sdks/http/index/TActivityStatus/readme.mdx deleted file mode 100644 index c035cd449..000000000 --- a/generated-docs/sdks/http/index/TActivityStatus/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "TActivityStatus" -mode: wide ---- - -# Type Alias: TActivityStatus - -> **TActivityStatus** = [`TActivity`](../TActivity/readme)\[`"status"`\] - -Defined in: [shared.ts:6](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L6) diff --git a/generated-docs/sdks/http/index/TActivityType/readme.mdx b/generated-docs/sdks/http/index/TActivityType/readme.mdx deleted file mode 100644 index 85ee603c2..000000000 --- a/generated-docs/sdks/http/index/TActivityType/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "TActivityType" -mode: wide ---- - -# Type Alias: TActivityType - -> **TActivityType** = [`TActivity`](../TActivity/readme)\[`"type"`\] - -Defined in: [shared.ts:7](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L7) diff --git a/generated-docs/sdks/http/index/TERMINAL_ACTIVITY_STATUSES/readme.mdx b/generated-docs/sdks/http/index/TERMINAL_ACTIVITY_STATUSES/readme.mdx deleted file mode 100644 index a6a079df2..000000000 --- a/generated-docs/sdks/http/index/TERMINAL_ACTIVITY_STATUSES/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "TERMINAL_ACTIVITY_STATUSES" -mode: wide ---- - -# Variable: TERMINAL\_ACTIVITY\_STATUSES - -> `const` **TERMINAL\_ACTIVITY\_STATUSES**: `definitions`\[`"v1ActivityStatus"`\][] - -Defined in: [shared.ts:118](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L118) diff --git a/generated-docs/sdks/http/index/TSignature/readme.mdx b/generated-docs/sdks/http/index/TSignature/readme.mdx deleted file mode 100644 index 3575d54e8..000000000 --- a/generated-docs/sdks/http/index/TSignature/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "TSignature" -mode: wide ---- - -# Type Alias: TSignature - -> **TSignature** = `definitions`\[`"v1SignRawPayloadResult"`\] - -Defined in: [shared.ts:8](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L8) diff --git a/generated-docs/sdks/http/index/TSignedRequest/readme.mdx b/generated-docs/sdks/http/index/TSignedRequest/readme.mdx deleted file mode 100644 index 9607dcfcb..000000000 --- a/generated-docs/sdks/http/index/TSignedRequest/readme.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "TSignedRequest" -mode: wide ---- - -# Type Alias: TSignedRequest - -> **TSignedRequest** = `object` - -Defined in: [base.ts:264](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L264) - -Represents a signed request ready to be POSTed to Turnkey - -## Properties - -### body - -> **body**: `string` - -Defined in: [base.ts:265](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L265) - -*** - -### stamp - -> **stamp**: `TStamp` - -Defined in: [base.ts:266](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L266) - -*** - -### url - -> **url**: `string` - -Defined in: [base.ts:267](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L267) diff --git a/generated-docs/sdks/http/index/TurnkeyActivityConsensusNeededError/readme.mdx b/generated-docs/sdks/http/index/TurnkeyActivityConsensusNeededError/readme.mdx deleted file mode 100644 index 3b8890966..000000000 --- a/generated-docs/sdks/http/index/TurnkeyActivityConsensusNeededError/readme.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "TurnkeyActivityConsensusNeededError" -mode: wide ---- - -# Class: TurnkeyActivityConsensusNeededError - -Defined in: [shared.ts:36](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L36) - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new TurnkeyActivityConsensusNeededError**(`input`): `TurnkeyActivityConsensusNeededError` - -Defined in: [shared.ts:42](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L42) - -#### Parameters - -##### input - -###### activityId? - -`string` - -###### activityStatus? - -`"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -###### activityType? - -`"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -###### cause? - -`Error` - -###### message - -`string` - -#### Returns - -`TurnkeyActivityConsensusNeededError` - -#### Overrides - -`Error.constructor` - -## Properties - -### activityId - -> **activityId**: `undefined` \| `string` - -Defined in: [shared.ts:37](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L37) - -*** - -### activityStatus - -> **activityStatus**: `undefined` \| `"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -Defined in: [shared.ts:38](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L38) - -*** - -### activityType - -> **activityType**: `undefined` \| `"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -Defined in: [shared.ts:39](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L39) - -*** - -### cause - -> **cause**: `undefined` \| `Error` - -Defined in: [shared.ts:40](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L40) diff --git a/generated-docs/sdks/http/index/TurnkeyActivityError/readme.mdx b/generated-docs/sdks/http/index/TurnkeyActivityError/readme.mdx deleted file mode 100644 index ee396ca7f..000000000 --- a/generated-docs/sdks/http/index/TurnkeyActivityError/readme.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: "TurnkeyActivityError" -mode: wide ---- - -# Class: TurnkeyActivityError - -Defined in: [shared.ts:12](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L12) - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new TurnkeyActivityError**(`input`): `TurnkeyActivityError` - -Defined in: [shared.ts:18](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L18) - -#### Parameters - -##### input - -###### activityId? - -`string` - -###### activityStatus? - -`"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -###### activityType? - -`"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -###### cause? - -`Error` - -###### message - -`string` - -#### Returns - -`TurnkeyActivityError` - -#### Overrides - -`Error.constructor` - -## Properties - -### activityId - -> **activityId**: `undefined` \| `string` - -Defined in: [shared.ts:13](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L13) - -*** - -### activityStatus - -> **activityStatus**: `undefined` \| `"ACTIVITY_STATUS_CREATED"` \| `"ACTIVITY_STATUS_PENDING"` \| `"ACTIVITY_STATUS_COMPLETED"` \| `"ACTIVITY_STATUS_FAILED"` \| `"ACTIVITY_STATUS_CONSENSUS_NEEDED"` \| `"ACTIVITY_STATUS_REJECTED"` - -Defined in: [shared.ts:14](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L14) - -*** - -### activityType - -> **activityType**: `undefined` \| `"ACTIVITY_TYPE_CREATE_API_KEYS"` \| `"ACTIVITY_TYPE_CREATE_USERS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD"` \| `"ACTIVITY_TYPE_CREATE_INVITATIONS"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION"` \| `"ACTIVITY_TYPE_CREATE_POLICY"` \| `"ACTIVITY_TYPE_DISABLE_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_DELETE_USERS"` \| `"ACTIVITY_TYPE_DELETE_API_KEYS"` \| `"ACTIVITY_TYPE_DELETE_INVITATION"` \| `"ACTIVITY_TYPE_DELETE_ORGANIZATION"` \| `"ACTIVITY_TYPE_DELETE_POLICY"` \| `"ACTIVITY_TYPE_CREATE_USER_TAG"` \| `"ACTIVITY_TYPE_DELETE_USER_TAGS"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION"` \| `"ACTIVITY_TYPE_APPROVE_ACTIVITY"` \| `"ACTIVITY_TYPE_REJECT_ACTIVITY"` \| `"ACTIVITY_TYPE_DELETE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEY_TAGS"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_ACTIVATE_BILLING_TIER"` \| `"ACTIVITY_TYPE_DELETE_PAYMENT_METHOD"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_POLICY_V3"` \| `"ACTIVITY_TYPE_CREATE_API_ONLY_USERS"` \| `"ACTIVITY_TYPE_UPDATE_ROOT_QUORUM"` \| `"ACTIVITY_TYPE_UPDATE_USER_TAG"` \| `"ACTIVITY_TYPE_UPDATE_PRIVATE_KEY_TAG"` \| `"ACTIVITY_TYPE_CREATE_AUTHENTICATORS_V2"` \| `"ACTIVITY_TYPE_CREATE_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V2"` \| `"ACTIVITY_TYPE_ACCEPT_INVITATION_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V2"` \| `"ACTIVITY_TYPE_UPDATE_ALLOWED_ORIGINS"` \| `"ACTIVITY_TYPE_CREATE_PRIVATE_KEYS_V2"` \| `"ACTIVITY_TYPE_UPDATE_USER"` \| `"ACTIVITY_TYPE_UPDATE_POLICY"` \| `"ACTIVITY_TYPE_SET_PAYMENT_METHOD_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V3"` \| `"ACTIVITY_TYPE_CREATE_WALLET"` \| `"ACTIVITY_TYPE_CREATE_WALLET_ACCOUNTS"` \| `"ACTIVITY_TYPE_INIT_USER_EMAIL_RECOVERY"` \| `"ACTIVITY_TYPE_RECOVER_USER"` \| `"ACTIVITY_TYPE_SET_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_REMOVE_ORGANIZATION_FEATURE"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOAD_V2"` \| `"ACTIVITY_TYPE_SIGN_TRANSACTION_V2"` \| `"ACTIVITY_TYPE_EXPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_EXPORT_WALLET"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V4"` \| `"ACTIVITY_TYPE_EMAIL_AUTH"` \| `"ACTIVITY_TYPE_EXPORT_WALLET_ACCOUNT"` \| `"ACTIVITY_TYPE_INIT_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_IMPORT_WALLET"` \| `"ACTIVITY_TYPE_INIT_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_IMPORT_PRIVATE_KEY"` \| `"ACTIVITY_TYPE_CREATE_POLICIES"` \| `"ACTIVITY_TYPE_SIGN_RAW_PAYLOADS"` \| `"ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION"` \| `"ACTIVITY_TYPE_CREATE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_DELETE_OAUTH_PROVIDERS"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V5"` \| `"ACTIVITY_TYPE_OAUTH"` \| `"ACTIVITY_TYPE_CREATE_API_KEYS_V2"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION"` \| `"ACTIVITY_TYPE_EMAIL_AUTH_V2"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V6"` \| `"ACTIVITY_TYPE_DELETE_PRIVATE_KEYS"` \| `"ACTIVITY_TYPE_DELETE_WALLETS"` \| `"ACTIVITY_TYPE_CREATE_READ_WRITE_SESSION_V2"` \| `"ACTIVITY_TYPE_DELETE_SUB_ORGANIZATION"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH"` \| `"ACTIVITY_TYPE_OTP_AUTH"` \| `"ACTIVITY_TYPE_CREATE_SUB_ORGANIZATION_V7"` \| `"ACTIVITY_TYPE_UPDATE_WALLET"` \| `"ACTIVITY_TYPE_UPDATE_POLICY_V2"` \| `"ACTIVITY_TYPE_CREATE_USERS_V3"` \| `"ACTIVITY_TYPE_INIT_OTP_AUTH_V2"` - -Defined in: [shared.ts:15](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L15) - -*** - -### cause - -> **cause**: `undefined` \| `Error` - -Defined in: [shared.ts:16](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L16) diff --git a/generated-docs/sdks/http/index/TurnkeyRequestError/readme.mdx b/generated-docs/sdks/http/index/TurnkeyRequestError/readme.mdx deleted file mode 100644 index 61a42cf52..000000000 --- a/generated-docs/sdks/http/index/TurnkeyRequestError/readme.mdx +++ /dev/null @@ -1,50 +0,0 @@ ---- -title: "TurnkeyRequestError" -mode: wide ---- - -# Class: TurnkeyRequestError - -Defined in: [base.ts:294](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L294) - -## Extends - -- `Error` - -## Constructors - -### Constructor - -> **new TurnkeyRequestError**(`input`): `TurnkeyRequestError` - -Defined in: [base.ts:298](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L298) - -#### Parameters - -##### input - -`GrpcStatus` - -#### Returns - -`TurnkeyRequestError` - -#### Overrides - -`Error.constructor` - -## Properties - -### code - -> **code**: `number` - -Defined in: [base.ts:296](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L296) - -*** - -### details - -> **details**: `null` \| `any`[] - -Defined in: [base.ts:295](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L295) diff --git a/generated-docs/sdks/http/index/VERSION/readme.mdx b/generated-docs/sdks/http/index/VERSION/readme.mdx deleted file mode 100644 index 333ece7c9..000000000 --- a/generated-docs/sdks/http/index/VERSION/readme.mdx +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: "VERSION" -mode: wide ---- - -# Variable: VERSION - -> `const` **VERSION**: `"@turnkey/http@3.0.0"` = `"@turnkey/http@3.0.0"` - -Defined in: [version.ts:1](https://github.com/tkhq/sdk/blob/main/packages/http/src/version.ts#L1) diff --git a/generated-docs/sdks/http/index/assertActivityCompleted/readme.mdx b/generated-docs/sdks/http/index/assertActivityCompleted/readme.mdx deleted file mode 100644 index fb24248a9..000000000 --- a/generated-docs/sdks/http/index/assertActivityCompleted/readme.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "AssertActivityCompleted" -mode: wide ---- - -# Function: assertActivityCompleted() - -> **assertActivityCompleted**(`activity`): `boolean` - -Defined in: [shared.ts:84](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L84) - -## Parameters - -### activity - -## Returns - -`boolean` diff --git a/generated-docs/sdks/http/index/assertNonNull/readme.mdx b/generated-docs/sdks/http/index/assertNonNull/readme.mdx deleted file mode 100644 index f36a4e906..000000000 --- a/generated-docs/sdks/http/index/assertNonNull/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "AssertNonNull" -mode: wide ---- - -# Function: assertNonNull() - -> **assertNonNull**\<`T`\>(`input`): `T` - -Defined in: [shared.ts:110](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L110) - -## Type Parameters - -### T - -`T` - -## Parameters - -### input - -`undefined` | `null` | `T` - -## Returns - -`T` diff --git a/generated-docs/sdks/http/index/browserInit/readme.mdx b/generated-docs/sdks/http/index/browserInit/readme.mdx deleted file mode 100644 index 8f87ed7b7..000000000 --- a/generated-docs/sdks/http/index/browserInit/readme.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "BrowserInit" -mode: wide ---- - -# Function: ~~browserInit()~~ - -> **browserInit**(`value`): `void` - -Defined in: [config.ts:38](https://github.com/tkhq/sdk/blob/main/packages/http/src/config.ts#L38) - -## Parameters - -### value - -`TBrowserConfig` - -## Returns - -`void` - -## Deprecated - -use [TurnkeyClient](../../TurnkeyClient/readme) instead, which doesn't rely on global initialization logic. diff --git a/generated-docs/sdks/http/index/createActivityPoller/readme.mdx b/generated-docs/sdks/http/index/createActivityPoller/readme.mdx deleted file mode 100644 index 49cf9e01b..000000000 --- a/generated-docs/sdks/http/index/createActivityPoller/readme.mdx +++ /dev/null @@ -1,64 +0,0 @@ ---- -title: "CreateActivityPoller" -mode: wide ---- - -# Function: createActivityPoller() - -> **createActivityPoller**\<`O`, `I`\>(`params`): (`input`) => `Promise`\<`O`\[`"activity"`\]\> - -Defined in: [async.ts:101](https://github.com/tkhq/sdk/blob/main/packages/http/src/async.ts#L101) - -Wraps a client request function (e.g. `client.createPrivateKeys`) in a poller. -The default refresh interval is 500ms. - -The returned poller will poll until the activity becomes `COMPLETED`. -If the activity becomes `FAILED` or `REJECTED` or is flagged as `NEEDS_CONSENSUS`, an error is thrown. - -## Type Parameters - -### O - -`O` *extends* `object` - -### I - -`I` *extends* `object` - -## Parameters - -### params - -#### client - -`TurnkeyClient` - -#### refreshIntervalMs? - -`number` - -#### requestFn - -(`input`) => `Promise`\<`O`\> - -## Returns - -`Function` - -### Parameters - -#### input - -`I` - -### Returns - -`Promise`\<`O`\[`"activity"`\]\> - -## Example - -```ts -const activityPoller = createActivityPoller(client, client.createPrivateKeys); -const activity = await activityPoller(input); -console.log(activity.result); // activity is completed -``` diff --git a/generated-docs/sdks/http/index/getSignatureFromActivity/readme.mdx b/generated-docs/sdks/http/index/getSignatureFromActivity/readme.mdx deleted file mode 100644 index b8ead01ab..000000000 --- a/generated-docs/sdks/http/index/getSignatureFromActivity/readme.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "GetSignatureFromActivity" -mode: wide ---- - -# Function: getSignatureFromActivity() - -> **getSignatureFromActivity**(`activity`): `object` - -Defined in: [shared.ts:131](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L131) - -This function is a helper method to easily extract a signature string from a completed signing activity. -Particularly useful for scenarios where a signature requires consensus - -## Parameters - -### activity - -the signing activity - -## Returns - -`object` - -signature {r, s, v} diff --git a/generated-docs/sdks/http/index/getSignaturesFromActivity/readme.mdx b/generated-docs/sdks/http/index/getSignaturesFromActivity/readme.mdx deleted file mode 100644 index 80f073fe8..000000000 --- a/generated-docs/sdks/http/index/getSignaturesFromActivity/readme.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "GetSignaturesFromActivity" -mode: wide ---- - -# Function: getSignaturesFromActivity() - -> **getSignaturesFromActivity**(`activity`): `object`[] - -Defined in: [shared.ts:159](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L159) - -This function is a helper method to easily extract signature strings from a completed signing activity. -Particularly useful for scenarios where a signature requires consensus - -## Parameters - -### activity - -the signing activity - -## Returns - -`object`[] - -signatures {r, s, v}[] diff --git a/generated-docs/sdks/http/index/getSignedTransactionFromActivity/readme.mdx b/generated-docs/sdks/http/index/getSignedTransactionFromActivity/readme.mdx deleted file mode 100644 index e83c634f6..000000000 --- a/generated-docs/sdks/http/index/getSignedTransactionFromActivity/readme.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "GetSignedTransactionFromActivity" -mode: wide ---- - -# Function: getSignedTransactionFromActivity() - -> **getSignedTransactionFromActivity**(`activity`): `string` - -Defined in: [shared.ts:182](https://github.com/tkhq/sdk/blob/main/packages/http/src/shared.ts#L182) - -This function is a helper method to easily extract a signed transaction from a completed signing activity. -Particularly useful for scenarios where a signature requires consensus - -## Parameters - -### activity - -the signing activity - -## Returns - -`string` - -signed transaction string diff --git a/generated-docs/sdks/http/index/getWebAuthnAttestation/readme.mdx b/generated-docs/sdks/http/index/getWebAuthnAttestation/readme.mdx deleted file mode 100644 index 8ef99f2f4..000000000 --- a/generated-docs/sdks/http/index/getWebAuthnAttestation/readme.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: "GetWebAuthnAttestation" -mode: wide ---- - -# Function: getWebAuthnAttestation() - -> **getWebAuthnAttestation**(`options`): `Promise`\<\{\}\> - -Defined in: [webauthn.ts:135](https://github.com/tkhq/sdk/blob/main/packages/http/src/webauthn.ts#L135) - -## Parameters - -### options - -`CredentialCreationOptions` - -## Returns - -`Promise`\<\{\}\> diff --git a/generated-docs/sdks/http/index/init/readme.mdx b/generated-docs/sdks/http/index/init/readme.mdx deleted file mode 100644 index dcf0529de..000000000 --- a/generated-docs/sdks/http/index/init/readme.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Init" -mode: wide ---- - -# Function: ~~init()~~ - -> **init**(`value`): `void` - -Defined in: [config.ts:45](https://github.com/tkhq/sdk/blob/main/packages/http/src/config.ts#L45) - -## Parameters - -### value - -`TConfig` - -## Returns - -`void` - -## Deprecated - -use [TurnkeyClient](../../TurnkeyClient/readme) instead, which doesn't rely on global initialization logic. diff --git a/generated-docs/sdks/http/index/readme.mdx b/generated-docs/sdks/http/index/readme.mdx deleted file mode 100644 index 55d825f12..000000000 --- a/generated-docs/sdks/http/index/readme.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Classes - -- [InvalidArgumentError](InvalidArgumentError/readme) -- [TurnkeyActivityConsensusNeededError](TurnkeyActivityConsensusNeededError/readme) -- [TurnkeyActivityError](TurnkeyActivityError/readme) -- [TurnkeyRequestError](TurnkeyRequestError/readme) - -## Type Aliases - -- [~~SignedRequest~~](SignedRequest/readme) -- [TActivity](TActivity/readme) -- [TActivityId](TActivityId/readme) -- [TActivityResponse](TActivityResponse/readme) -- [TActivityStatus](TActivityStatus/readme) -- [TActivityType](TActivityType/readme) -- [TSignature](TSignature/readme) -- [TSignedRequest](TSignedRequest/readme) - -## Variables - -- [TERMINAL\_ACTIVITY\_STATUSES](TERMINAL_ACTIVITY_STATUSES/readme) -- [VERSION](VERSION/readme) - -## Functions - -- [assertActivityCompleted](assertActivityCompleted/readme) -- [assertNonNull](assertNonNull/readme) -- [~~browserInit~~](browserInit/readme) -- [createActivityPoller](createActivityPoller/readme) -- [getSignatureFromActivity](getSignatureFromActivity/readme) -- [getSignaturesFromActivity](getSignaturesFromActivity/readme) -- [getSignedTransactionFromActivity](getSignedTransactionFromActivity/readme) -- [getWebAuthnAttestation](getWebAuthnAttestation/readme) -- [~~init~~](init/readme) -- [sealAndStampRequestBody](sealAndStampRequestBody/readme) -- [~~withAsyncPolling~~](withAsyncPolling/readme) diff --git a/generated-docs/sdks/http/index/sealAndStampRequestBody/readme.mdx b/generated-docs/sdks/http/index/sealAndStampRequestBody/readme.mdx deleted file mode 100644 index eb4464958..000000000 --- a/generated-docs/sdks/http/index/sealAndStampRequestBody/readme.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "SealAndStampRequestBody" -mode: wide ---- - -# Function: sealAndStampRequestBody() - -> **sealAndStampRequestBody**(`input`): `Promise`\<\{ `sealedBody`: `string`; `xStamp`: `string`; \}\> - -Defined in: [base.ts:216](https://github.com/tkhq/sdk/blob/main/packages/http/src/base.ts#L216) - -Seals and stamps the request body with your Turnkey API credentials. - -You can either: -- Before calling `sealAndStampRequestBody(...)`, initialize with your Turnkey API credentials via `init(...)` -- Or, provide `apiPublicKey` and `apiPrivateKey` here as arguments - -## Parameters - -### input - -#### apiPrivateKey? - -`string` - -#### apiPublicKey? - -`string` - -#### body - -`Record`\<`string`, `any`\> - -## Returns - -`Promise`\<\{ `sealedBody`: `string`; `xStamp`: `string`; \}\> diff --git a/generated-docs/sdks/http/index/withAsyncPolling/readme.mdx b/generated-docs/sdks/http/index/withAsyncPolling/readme.mdx deleted file mode 100644 index cf057bb05..000000000 --- a/generated-docs/sdks/http/index/withAsyncPolling/readme.mdx +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: "WithAsyncPolling" -mode: wide ---- - -# Function: ~~withAsyncPolling()~~ - -> **withAsyncPolling**\<`O`, `I`\>(`params`): (`input`) => `Promise`\<`O`\[`"activity"`\]\> - -Defined in: [async.ts:13](https://github.com/tkhq/sdk/blob/main/packages/http/src/async.ts#L13) - -Wraps a request to create a fetcher with built-in async polling support. - -## Type Parameters - -### O - -`O` *extends* `object` - -### I - -`I` *extends* `object` - -## Parameters - -### params - -#### refreshIntervalMs? - -`number` - -#### request - -(`input`) => `Promise`\<`O`\> - -## Returns - -`Function` - -### Parameters - -#### input - -`I` - -### Returns - -`Promise`\<`O`\[`"activity"`\]\> - -## Deprecated - -this function only works with TurnkeyApi. -Use [TurnkeyClient](../../TurnkeyClient/readme) and [createActivityPoller](../createActivityPoller/readme) instead. diff --git a/generated-docs/sdks/http/readme.mdx b/generated-docs/sdks/http/readme.mdx deleted file mode 100644 index ab09a13e3..000000000 --- a/generated-docs/sdks/http/readme.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: "Http" -mode: wide ---- - -# @turnkey/http - -[![npm](https://img.shields.io/npm/v/@turnkey/http?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/http) - -A lower-level, fully typed HTTP client for interacting with [Turnkey](https://turnkey.com) API. - -For signing transactions and messages, check out the higher-level [`@turnkey/ethers`](https://www.npmjs.com/package/@turnkey/ethers) or [`@turnkey/viem`](https://www.npmjs.com/package/@turnkey/viem) signers. - -Turnkey API documentation lives here: https://docs.turnkey.com. - -## Getting started - -```bash -$ npm install @turnkey/http -``` - -```typescript -import { ApiKeyStamper } from "@turnkey/api-key-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -// This stamper produces signatures using the API key pair passed in. -const stamper = new ApiKeyStamper({ - apiPublicKey: "...", - apiPrivateKey: "...", -}); - -// The Turnkey client uses the passed in stamper to produce signed requests -// and sends them to Turnkey -const client = new TurnkeyClient( - { - baseUrl: "https://api.turnkey.com", - }, - stamper, -); - -// Now you can make authenticated requests! -const data = await client.getWhoami({ - organizationId: "", -}); -``` - -## HTTP fetchers - -`@turnkey/http` provides fully typed http fetchers for interacting with the Turnkey API. You can find all available methods [here](/packages/http/src/__generated__/services/coordinator/public/v1/public_api.fetcher.ts). The types of input parameters and output responses are also exported for convenience. - -The OpenAPI spec that generates all fetchers is also [included](/packages/http/src/__generated__/services/coordinator/public/v1/public_api.swagger.json) in the package. - -## `withAsyncPolling(...)` helper - -All Turnkey mutation endpoints are asynchronous (with the exception of private key-related signing endpoints, e.g. `/submit/sign_transaction`, `/submit/sign_raw_payload`). To help you simplify async mutations, `@turnkey/http` provides a `withAsyncPolling(...)` wrapper. Here's a quick example: - -```typescript -import { withAsyncPolling, TurnkeyActivityError } from "@turnkey/http"; - -// Use `withAsyncPolling(...)` to wrap & create a fetcher with built-in async polling support -const fetcher = withAsyncPolling({ - request: client.createPrivateKeys, -}); - -// The fetcher remains fully typed. After submitting the request, -// it'll poll until the activity reaches a terminal state. -try { - const activity = await fetcher({ - body: { - /* ... */ - }, - }); - - // Success! - console.log( - activity.result.createPrivateKeysResultV2?.privateKeys?.[0]?.privateKeyId, - ); -} catch (error) { - if (error instanceof TurnkeyActivityError) { - // In case the activity is rejected, failed, or requires consensus, - // a rich `TurnkeyActivityError` will be thrown. You can read from - // `TurnkeyActivityError` to find out why the activity didn't succeed. - // - // For instance, if your activity requires consensus and doesn't have - // enough approvals, you can get the `activityId` from `TurnkeyActivityError`, - // store it somewhere, then re-fetch the activity via `.postGetActivity(...)` - // when the required approvals/rejections are in place. - } -} -``` - -## More examples - -See [`createNewEthereumPrivateKey.ts`](/examples/with-ethers/src/createNewEthereumPrivateKey.ts) in the [`with-ethers`](/examples/with-ethers/) example. - -## See also - -- [`@turnkey/ethers`](https://www.npmjs.com/package/@turnkey/ethers): Turnkey Signer for [`Ethers`](https://docs.ethers.org/v6/api/providers/#Signer) -- [`@turnkey/viem`](https://www.npmjs.com/package/@turnkey/viem): Turnkey Custom Account for [`Viem`](https://viem.sh/docs/accounts/custom.html) - -## Documents - -- [TurnkeyClient](TurnkeyClient/readme) - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/iframe-stamper/IframeStamper/readme.mdx b/generated-docs/sdks/iframe-stamper/IframeStamper/readme.mdx deleted file mode 100644 index 481e27f08..000000000 --- a/generated-docs/sdks/iframe-stamper/IframeStamper/readme.mdx +++ /dev/null @@ -1,226 +0,0 @@ ---- -title: "IframeStamper" -mode: wide ---- - -## Introduction - -The [`@turnkey/iframe-stamper`](https://www.npmjs.com/package/@turnkey/iframe-stamper) package, while sharing a similar purpose with the `@turnkey/api-key-stamper`, caters specifically to the unique context of iframes. This package is designed for stamping requests within an iframe, using credentials for Turnkey's API, but operates distinctly from the API key stamper. Unlike the API key stamper, which has direct access to the API private key to compute signatures or stamps directly, the iframe stamper interacts with credentials in a more indirect manner. - -It leverages the `postMessage` communication mechanism to send and receive messages within the iframe, ensuring the credential does not leave its secure environment. This approach is particularly crucial in sensitive flows such as [Email Auth](/authentication/email), and [Key or Wallet Export](/wallets/export-wallets), where heightened security is required. The `@turnkey/iframe-stamper` works in tandem with `@turnkey/http`, facilitating secure and efficient communication in these specific use cases. - -By bridging the gap between the iframe's isolated environment and Turnkey's API, the iframe stamper plays a pivotal role in maintaining the integrity and security of the credential while ensuring seamless operation within the iframe context. - -## Installing - -To start using the `@turnkey/iframe-stamper` client, install it as follows: - - - -```bash npm -npm i @turnkey/iframe-stamper -``` - -```bash pnpm -pnpm i @turnkey/iframe-stamper -``` - -```bash yarn -yarn add @turnkey/iframe-stamper -``` - - - -## Initializing - -The IframeStamper class, part of the @turnkey/iframe-stamper package, is designed for stamping Turnkey requests through credentials in an iframe. It's used with @turnkey/http for constructing various flows. The class can manage iframe interactions for credential insertion, wallet exports, and request stamping. Here's how you can initialize an IframeStamper: - -### `constructor(config: TIframeStamperConfig): IframeStamper` - -#### Parameters - - - -An object containing configuration settings for the iframe stamper. - - - -The URL of the iframe to be used. - - - -The ID to assign to the iframe element. - - - -The container element in which the iframe will be inserted. - - -#### Types - -##### `TIframeStamperConfig` - -```js -type TIframeStamperConfig = { - iframeUrl: string; - iframeElementId: string; - iframeContainer: HTMLElement | null | undefined; -}; -``` - -#### Example - -For full example check out the [email-auth](https://github.com/tkhq/sdk/tree/main/examples/email-auth) example in our SDK repo. You should also read up [Email Auth](/authentication/email) for more information on the technical details of how it works. - -## Methods - -### `init: () => Promise` - -Initializes the iframe stamper by inserting the iframe into the DOM and establishing communication with it. This method returns a promise that resolves to the iframe's public key, which is used for subsequent operations like credential injection or request stamping. - -#### Example - -```js -import { IframeStamper } from "@turnkey/iframe-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -const TurnkeyIframeContainerId = "turnkey-iframe-container"; -const TurnkeyIframeElementId = "turnkey-iframe"; - -const iframeStamper = new IframeStamper({ - iframeUrl: process.env.IFRAME_URL!, - iframeContainer: document.getElementById(TurnkeyIframeContainerId), - iframeElementId: TurnkeyIframeElementId, -}); - -// This inserts the iframe in the DOM and returns the public key -const publicKey = await iframeStamper.init(); -``` - -### `injectCredentialBundle: (bundle: string) => Promise` - -Injects a new credential bundle into the iframe, a process used in email authentication flows. The method requires an encrypted credential bundle, which should be encrypted to the iframe's initial public key using HPKE ([RFC 9180](https://www.rfc-editor.org/rfc/rfc9180.html)). Upon successful execution, it returns a `Promise` that resolves to `true` if the bundle was successfully injected into the iframe, or `false` otherwise. - -#### Parameters - - - -The encrypted credential bundle that needs to be injected into the iframe. This bundle should be encrypted with the iframe's initial public key using HPKE ([RFC 9180](https://www.rfc-editor.org/rfc/rfc9180.html)). - - -#### Example - -``` -// .. Add imports and init iframeStamper - -// Pasted into the iFrame by the user -const credentialBundle = ""; - -// Injects a new credential in the iframe -const injected = await iframeStamper.injectCredentialBundle(credentialBundle); -``` - -### `injectKeyExportBundle: (bundle: string) => Promise` - -Injects an export bundle into the iframe. This method is used during key export flows. The bundle should be encrypted to the iframe's initial public key using HPKE ([RFC 9180](https://www.rfc-editor.org/rfc/rfc9180.html)). This method returns a `Promise` which resolves to `true` if the bundle was successfully injected into the iframe, or `false` otherwise. - -#### Parameters - - - -The encrypted export bundle that needs to be injected into the iframe. This bundle should be encrypted with the iframe's initial public key using HPKE ([RFC 9180](https://www.rfc-editor.org/rfc/rfc9180.html)). - - -#### Example - -```js -// .. Add imports and init the IframeStamper - -// Pasted into the iFrame by the user -const walletExportBundle = ""; - -const injected = - await iframeStamper.injectWalletExportBundle(walletExportBundle); -``` - -### `injectWalletExportBundle: (bundle: string) => Promise` - -Injects a wallet export bundle into the iframe. This method is typically used during wallet export flows. The bundle should be encrypted to the iframe's initial public key using HPKE (RFC 9180). It returns a `Promise` which resolves to `true` if the bundle is successfully injected into the iframe, or `false` otherwise. - -#### Parameters - - - -The encrypted wallet export bundle to be injected into the iframe. This bundle must be encrypted using the iframe's initial public key according to HPKE (RFC 9180) standards. - - -#### Example - -```js -// .. Add imports and init the IframeStamper - -// Pasted into the iFrame by the user -const walletExportBundle = ""; - -const injected = - await iframeStamper.injectWalletExportBundle(walletExportBundle); -``` - -### `publicKey: () => string | null` - -Returns the public key of the iframe, or `null` if the underlying iframe isn't properly initialized. This method is useful for retrieving the public key which is necessary for various operations like credential injection or request stamping. - -#### Example - -```js -// .. Add imports and init the IframeStamper - -const iframePublicKey = iframeStamper.publicKey(); -``` - -### `clear: () => void` - -Removes the iframe from the DOM. This method is useful for cleaning up the iframe when it is no longer needed. It ensures that the iframe is properly disposed of, preventing potential memory leaks or other unintended side effects. - -#### Example - -```js -// .. Add imports and init the IframeStamper - -iframeStamper.clear(); -``` diff --git a/generated-docs/sdks/iframe-stamper/index/IframeEventType/readme.mdx b/generated-docs/sdks/iframe-stamper/index/IframeEventType/readme.mdx deleted file mode 100644 index fb77ce67f..000000000 --- a/generated-docs/sdks/iframe-stamper/index/IframeEventType/readme.mdx +++ /dev/null @@ -1,152 +0,0 @@ ---- -title: "IframeEventType" -mode: wide ---- - -# Enumeration: IframeEventType - -Defined in: [index.ts:7](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L7) - -## Enumeration Members - -### ApplySettings - -> **ApplySettings**: `"APPLY_SETTINGS"` - -Defined in: [index.ts:34](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L34) - -*** - -### BundleInjected - -> **BundleInjected**: `"BUNDLE_INJECTED"` - -Defined in: [index.ts:37](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L37) - -*** - -### ClearEmbeddedKey - -> **ClearEmbeddedKey**: `"RESET_EMBEDDED_KEY"` - -Defined in: [index.ts:58](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L58) - -*** - -### EncryptedBundleExtracted - -> **EncryptedBundleExtracted**: `"ENCRYPTED_BUNDLE_EXTRACTED"` - -Defined in: [index.ts:40](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L40) - -*** - -### Error - -> **Error**: `"ERROR"` - -Defined in: [index.ts:64](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L64) - -*** - -### ExtractKeyEncryptedBundle - -> **ExtractKeyEncryptedBundle**: `"EXTRACT_KEY_ENCRYPTED_BUNDLE"` - -Defined in: [index.ts:31](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L31) - -*** - -### ExtractWalletEncryptedBundle - -> **ExtractWalletEncryptedBundle**: `"EXTRACT_WALLET_ENCRYPTED_BUNDLE"` - -Defined in: [index.ts:27](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L27) - -*** - -### GetEmbeddedPublicKey - -> **GetEmbeddedPublicKey**: `"GET_EMBEDDED_PUBLIC_KEY"` - -Defined in: [index.ts:55](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L55) - -*** - -### InitEmbeddedKey - -> **InitEmbeddedKey**: `"INIT_EMBEDDED_KEY"` - -Defined in: [index.ts:61](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L61) - -*** - -### InjectCredentialBundle - -> **InjectCredentialBundle**: `"INJECT_CREDENTIAL_BUNDLE"` - -Defined in: [index.ts:13](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L13) - -*** - -### InjectImportBundle - -> **InjectImportBundle**: `"INJECT_IMPORT_BUNDLE"` - -Defined in: [index.ts:24](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L24) - -*** - -### InjectKeyExportBundle - -> **InjectKeyExportBundle**: `"INJECT_KEY_EXPORT_BUNDLE"` - -Defined in: [index.ts:18](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L18) - -*** - -### InjectWalletExportBundle - -> **InjectWalletExportBundle**: `"INJECT_WALLET_EXPORT_BUNDLE"` - -Defined in: [index.ts:21](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L21) - -*** - -### PublicKeyReady - -> **PublicKeyReady**: `"PUBLIC_KEY_READY"` - -Defined in: [index.ts:10](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L10) - -*** - -### SettingsApplied - -> **SettingsApplied**: `"SETTINGS_APPLIED"` - -Defined in: [index.ts:43](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L43) - -*** - -### Stamp - -> **Stamp**: `"STAMP"` - -Defined in: [index.ts:49](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L49) - -*** - -### StampRequest - -> **StampRequest**: `"STAMP_REQUEST"` - -Defined in: [index.ts:46](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L46) - -*** - -### TurnkeyInitMessageChannel - -> **TurnkeyInitMessageChannel**: `"TURNKEY_INIT_MESSAGE_CHANNEL"` - -Defined in: [index.ts:52](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L52) diff --git a/generated-docs/sdks/iframe-stamper/index/IframeStamper/readme.mdx b/generated-docs/sdks/iframe-stamper/index/IframeStamper/readme.mdx deleted file mode 100644 index 6d766dc31..000000000 --- a/generated-docs/sdks/iframe-stamper/index/IframeStamper/readme.mdx +++ /dev/null @@ -1,380 +0,0 @@ ---- -title: "IframeStamper" -mode: wide ---- - -# Class: IframeStamper - -Defined in: [index.ts:129](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L129) - -Stamper to use with `@turnkey/http`'s `TurnkeyClient` -Creating a stamper inserts an iframe in the current page. - -## Constructors - -### Constructor - -> **new IframeStamper**(`config`): `IframeStamper` - -Defined in: [index.ts:142](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L142) - -Creates a new iframe stamper. This function _does not_ insert the iframe in the DOM. -Call `.init()` to insert the iframe element in the DOM. - -#### Parameters - -##### config - -[`TIframeStamperConfig`](../TIframeStamperConfig/readme) - -#### Returns - -`IframeStamper` - -## Properties - -### container - -> **container**: `HTMLElement` - -Defined in: [index.ts:130](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L130) - -*** - -### iframe - -> **iframe**: `HTMLIFrameElement` - -Defined in: [index.ts:131](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L131) - -*** - -### iframeOrigin - -> **iframeOrigin**: `string` - -Defined in: [index.ts:132](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L132) - -*** - -### iframePublicKey - -> **iframePublicKey**: `null` \| `string` - -Defined in: [index.ts:133](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L133) - -*** - -### messageChannel - -> **messageChannel**: `MessageChannel` - -Defined in: [index.ts:134](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L134) - -## Methods - -### applySettings() - -> **applySettings**(`settings`): `Promise`\<`boolean`\> - -Defined in: [index.ts:451](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L451) - -Function to apply settings on allowed parameters in the iframe -This is used to style the HTML element used for plaintext in wallet and private key import. - -#### Parameters - -##### settings - -[`TIframeSettings`](../TIframeSettings/readme) - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### clear() - -> **clear**(): `void` - -Defined in: [index.ts:276](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L276) - -Removes the iframe from the DOM - -#### Returns - -`void` - -*** - -### clearEmbeddedKey() - -> **clearEmbeddedKey**(): `Promise`\<`null`\> - -Defined in: [index.ts:306](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L306) - -Clears the embedded key within an iframe. - -#### Returns - -`Promise`\<`null`\> - -*** - -### extractKeyEncryptedBundle() - -> **extractKeyEncryptedBundle**(`keyFormat`?): `Promise`\<`string`\> - -Defined in: [index.ts:440](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L440) - -Function to extract an encrypted bundle from the iframe -The bundle should be encrypted to Turnkey's Signer enclave's initial public key -Encryption should be performed with HPKE (RFC 9180). -The key format to encode the private key in before it's encrypted and imported: HEXADECIMAL or SOLANA. Defaults to HEXADECIMAL. -This is used during the private key import flow. - -#### Parameters - -##### keyFormat? - -[`KeyFormat`](../KeyFormat/readme) - -#### Returns - -`Promise`\<`string`\> - -*** - -### extractWalletEncryptedBundle() - -> **extractWalletEncryptedBundle**(): `Promise`\<`string`\> - -Defined in: [index.ts:427](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L427) - -Function to extract an encrypted bundle from the iframe -The bundle should be encrypted to Turnkey's Signer enclave's initial public key -Encryption should be performed with HPKE (RFC 9180). -This is used during the wallet import flow. - -#### Returns - -`Promise`\<`string`\> - -*** - -### getEmbeddedPublicKey() - -> **getEmbeddedPublicKey**(): `Promise`\<`null` \| `string`\> - -Defined in: [index.ts:294](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L294) - -Returns the public key, or `null` if the underlying iframe isn't properly initialized. -This differs from the above in that it reaches out to the live iframe to see if an embedded key exists. - -#### Returns - -`Promise`\<`null` \| `string`\> - -*** - -### init() - -> **init**(`dangerouslyOverrideIframeKeyTtl`?): `Promise`\<`string`\> - -Defined in: [index.ts:234](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L234) - -Inserts the iframe on the page and returns a promise resolving to the iframe's public key - -#### Parameters - -##### dangerouslyOverrideIframeKeyTtl? - -`number` - -Optional TTL override for the iframe's embedded key (default 48 hours). Only use this if you are intentional about the security implications. - -#### Returns - -`Promise`\<`string`\> - -*** - -### initEmbeddedKey() - -> **initEmbeddedKey**(): `Promise`\<`null` \| `string`\> - -Defined in: [index.ts:319](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L319) - -Creates a new embedded key within an iframe. If an embedded key already exists, this will return it. -This is primarily to be used in conjunction with `clearEmbeddedKey()`: after an embedded key is cleared, -this can be used to create a new one. - -#### Returns - -`Promise`\<`null` \| `string`\> - -the newly created embedded public key. - -*** - -### injectCredentialBundle() - -> **injectCredentialBundle**(`bundle`): `Promise`\<`boolean`\> - -Defined in: [index.ts:361](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L361) - -Function to inject a new credential into the iframe -The bundle should be encrypted to the iframe's initial public key -Encryption should be performed with HPKE (RFC 9180). -This is used during recovery and auth flows. - -#### Parameters - -##### bundle - -`string` - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### injectImportBundle() - -> **injectImportBundle**(`bundle`, `organizationId`, `userId`): `Promise`\<`boolean`\> - -Defined in: [index.ts:409](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L409) - -Function to inject an import bundle into the iframe -This is used to initiate either the wallet import flow or the private key import flow. - -#### Parameters - -##### bundle - -`string` - -##### organizationId - -`string` - -##### userId - -`string` - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### injectKeyExportBundle() - -> **injectKeyExportBundle**(`bundle`, `organizationId`, `keyFormat`?): `Promise`\<`boolean`\> - -Defined in: [index.ts:374](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L374) - -Function to inject an export bundle into the iframe -The bundle should be encrypted to the iframe's initial public key -Encryption should be performed with HPKE (RFC 9180). -The key format to encode the private key in after it's exported and decrypted: HEXADECIMAL or SOLANA. Defaults to HEXADECIMAL. -This is used during the private key export flow. - -#### Parameters - -##### bundle - -`string` - -##### organizationId - -`string` - -##### keyFormat? - -[`KeyFormat`](../KeyFormat/readme) - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### injectWalletExportBundle() - -> **injectWalletExportBundle**(`bundle`, `organizationId`): `Promise`\<`boolean`\> - -Defined in: [index.ts:392](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L392) - -Function to inject an export bundle into the iframe -The bundle should be encrypted to the iframe's initial public key -Encryption should be performed with HPKE (RFC 9180). -This is used during the wallet export flow. - -#### Parameters - -##### bundle - -`string` - -##### organizationId - -`string` - -#### Returns - -`Promise`\<`boolean`\> - -*** - -### onMessageHandler() - -> **onMessageHandler**(`event`): `void` - -Defined in: [index.ts:191](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L191) - -#### Parameters - -##### event - -`MessageEvent` - -#### Returns - -`void` - -*** - -### publicKey() - -> **publicKey**(): `null` \| `string` - -Defined in: [index.ts:286](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L286) - -Returns the public key, or `null` if the underlying iframe isn't properly initialized. - -#### Returns - -`null` \| `string` - -*** - -### stamp() - -> **stamp**(`payload`): `Promise`\<`TStamp`\> - -Defined in: [index.ts:460](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L460) - -Function to sign a payload with the underlying iframe - -#### Parameters - -##### payload - -`string` - -#### Returns - -`Promise`\<`TStamp`\> diff --git a/generated-docs/sdks/iframe-stamper/index/KeyFormat/readme.mdx b/generated-docs/sdks/iframe-stamper/index/KeyFormat/readme.mdx deleted file mode 100644 index 61e6b3d55..000000000 --- a/generated-docs/sdks/iframe-stamper/index/KeyFormat/readme.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "KeyFormat" -mode: wide ---- - -# Enumeration: KeyFormat - -Defined in: [index.ts:69](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L69) - -## Enumeration Members - -### Hexadecimal - -> **Hexadecimal**: `"HEXADECIMAL"` - -Defined in: [index.ts:71](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L71) - -*** - -### Solana - -> **Solana**: `"SOLANA"` - -Defined in: [index.ts:73](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L73) diff --git a/generated-docs/sdks/iframe-stamper/index/TIframeSettings/readme.mdx b/generated-docs/sdks/iframe-stamper/index/TIframeSettings/readme.mdx deleted file mode 100644 index 76439d520..000000000 --- a/generated-docs/sdks/iframe-stamper/index/TIframeSettings/readme.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "TIframeSettings" -mode: wide ---- - -# Type Alias: TIframeSettings - -> **TIframeSettings** = `object` - -Defined in: [index.ts:111](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L111) - -## Properties - -### styles? - -> `optional` **styles**: [`TIframeStyles`](../TIframeStyles/readme) - -Defined in: [index.ts:112](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L112) diff --git a/generated-docs/sdks/iframe-stamper/index/TIframeStamperConfig/readme.mdx b/generated-docs/sdks/iframe-stamper/index/TIframeStamperConfig/readme.mdx deleted file mode 100644 index 5d4793d19..000000000 --- a/generated-docs/sdks/iframe-stamper/index/TIframeStamperConfig/readme.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "TIframeStamperConfig" -mode: wide ---- - -# Type Alias: TIframeStamperConfig - -> **TIframeStamperConfig** = `object` - -Defined in: [index.ts:81](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L81) - -## Properties - -### iframeContainer - -> **iframeContainer**: `HTMLElement` \| `null` \| `undefined` - -Defined in: [index.ts:84](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L84) - -*** - -### iframeElementId - -> **iframeElementId**: `string` - -Defined in: [index.ts:83](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L83) - -*** - -### iframeUrl - -> **iframeUrl**: `string` - -Defined in: [index.ts:82](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L82) diff --git a/generated-docs/sdks/iframe-stamper/index/TIframeStyles/readme.mdx b/generated-docs/sdks/iframe-stamper/index/TIframeStyles/readme.mdx deleted file mode 100644 index 05748f671..000000000 --- a/generated-docs/sdks/iframe-stamper/index/TIframeStyles/readme.mdx +++ /dev/null @@ -1,178 +0,0 @@ ---- -title: "TIframeStyles" -mode: wide ---- - -# Type Alias: TIframeStyles - -> **TIframeStyles** = `object` - -Defined in: [index.ts:87](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L87) - -## Properties - -### backgroundColor? - -> `optional` **backgroundColor**: `string` - -Defined in: [index.ts:98](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L98) - -*** - -### borderColor? - -> `optional` **borderColor**: `string` - -Defined in: [index.ts:92](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L92) - -*** - -### borderRadius? - -> `optional` **borderRadius**: `string` - -Defined in: [index.ts:93](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L93) - -*** - -### borderStyle? - -> `optional` **borderStyle**: `string` - -Defined in: [index.ts:91](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L91) - -*** - -### borderWidth? - -> `optional` **borderWidth**: `string` - -Defined in: [index.ts:90](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L90) - -*** - -### boxShadow? - -> `optional` **boxShadow**: `string` - -Defined in: [index.ts:104](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L104) - -*** - -### color? - -> `optional` **color**: `string` - -Defined in: [index.ts:97](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L97) - -*** - -### fontFamily? - -> `optional` **fontFamily**: `string` - -Defined in: [index.ts:96](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L96) - -*** - -### fontSize? - -> `optional` **fontSize**: `string` - -Defined in: [index.ts:94](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L94) - -*** - -### fontWeight? - -> `optional` **fontWeight**: `string` - -Defined in: [index.ts:95](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L95) - -*** - -### height? - -> `optional` **height**: `string` - -Defined in: [index.ts:100](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L100) - -*** - -### lineHeight? - -> `optional` **lineHeight**: `string` - -Defined in: [index.ts:103](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L103) - -*** - -### margin? - -> `optional` **margin**: `string` - -Defined in: [index.ts:89](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L89) - -*** - -### maxHeight? - -> `optional` **maxHeight**: `string` - -Defined in: [index.ts:102](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L102) - -*** - -### maxWidth? - -> `optional` **maxWidth**: `string` - -Defined in: [index.ts:101](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L101) - -*** - -### overflowWrap? - -> `optional` **overflowWrap**: `string` - -Defined in: [index.ts:106](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L106) - -*** - -### padding? - -> `optional` **padding**: `string` - -Defined in: [index.ts:88](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L88) - -*** - -### resize? - -> `optional` **resize**: `string` - -Defined in: [index.ts:108](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L108) - -*** - -### textAlign? - -> `optional` **textAlign**: `string` - -Defined in: [index.ts:105](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L105) - -*** - -### width? - -> `optional` **width**: `string` - -Defined in: [index.ts:99](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L99) - -*** - -### wordWrap? - -> `optional` **wordWrap**: `string` - -Defined in: [index.ts:107](https://github.com/tkhq/sdk/blob/main/packages/iframe-stamper/src/index.ts#L107) diff --git a/generated-docs/sdks/iframe-stamper/index/readme.mdx b/generated-docs/sdks/iframe-stamper/index/readme.mdx deleted file mode 100644 index f870074a6..000000000 --- a/generated-docs/sdks/iframe-stamper/index/readme.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Enumerations - -- [IframeEventType](IframeEventType/readme) -- [KeyFormat](KeyFormat/readme) - -## Classes - -- [IframeStamper](IframeStamper/readme) - -## Type Aliases - -- [TIframeSettings](TIframeSettings/readme) -- [TIframeStamperConfig](TIframeStamperConfig/readme) -- [TIframeStyles](TIframeStyles/readme) diff --git a/generated-docs/sdks/iframe-stamper/readme.mdx b/generated-docs/sdks/iframe-stamper/readme.mdx deleted file mode 100644 index 96feea998..000000000 --- a/generated-docs/sdks/iframe-stamper/readme.mdx +++ /dev/null @@ -1,118 +0,0 @@ ---- -title: "Iframe Stamper" -mode: wide ---- - -# @turnkey/iframe-stamper - -[![npm](https://img.shields.io/npm/v/@turnkey/iframe-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/iframe-stamper) - -This package contains functions to stamp a Turnkey request through credentials contained in an iframe. It is meant to be used with [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http) to build flows. To stamp the request, use the Recovery and Auth flows to request and inject a credential bundle. - -Usage: - -Recovery and Auth - -```ts -import { IframeStamper } from "@turnkey/iframe-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -const TurnkeyIframeContainerId = "turnkey-iframe-container"; -const TurnkeyIframeElementId = "turnkey-iframe"; - -const iframeStamper = new IframeStamper({ - iframeUrl: process.env.AUTH_IFRAME_URL!, - iframeContainer: document.getElementById(TurnkeyIframeContainerId), - iframeElementId: TurnkeyIframeElementId, -}); - -// This inserts the iframe in the DOM and returns the public key -const publicKey = await iframeStamper.init(); - -// Injects a new credential in the iframe -const injected = await iframeStamper.injectCredentialBundle(credentialBundle); - -// New HTTP client able to sign with the credentials inside of the iframe -const httpClient = new TurnkeyClient( - { baseUrl: "https://api.turnkey.com" }, - iframeStamper, -); -``` - -Key or Wallet Export - -```ts -import { IframeStamper } from "@turnkey/iframe-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -const TurnkeyIframeContainerId = "turnkey-iframe-container"; -const TurnkeyIframeElementId = "turnkey-iframe"; - -const iframeStamper = new IframeStamper({ - iframeUrl: process.env.EXPORT_IFRAME_URL!, - iframeContainer: document.getElementById(TurnkeyIframeContainerId), - iframeElementId: TurnkeyIframeElementId, -}); - -// This inserts the iframe in the DOM and returns the public key -const publicKey = await iframeStamper.init(); - -// Injects a bundle containing the encrypted wallet seedphrase into the iframe -// `exportBundle` is the response from requesting ACTIVITY_TYPE_EXPORT_WALLET -const injected = await iframeStamper.injectWalletExportBundle(exportBundle); - -// If the bundle is successfully injected, the iframe is now displaying the -// wallet seedphrase to the user -if (injected !== true) { - throw new Error("unexpected error while injecting export bundle"); -} - -// Display the iframe to the user with their seedphrase. -setIframeDisplay("block"); -``` - -Key or Wallet Import - -```ts -import { IframeStamper } from "@turnkey/iframe-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -const TurnkeyIframeContainerId = "turnkey-iframe-container"; -const TurnkeyIframeElementId = "turnkey-iframe"; - -const iframeStamper = new IframeStamper({ - iframeUrl: process.env.IMPORT_IFRAME_URL!, - iframeContainer: document.getElementById(TurnkeyIframeContainerId), - iframeElementId: TurnkeyIframeElementId, -}); - -// This inserts the iframe in the DOM -await iframeStamper.init(); - -// Injects a bundle containing the secure enclave's public key into the iframe's local storage -// `importBundle` is the response from requesting ACTIVITY_TYPE_INIT_IMPORT_WALLET -const injected = await iframeStamper.injectImportBundle(importBundle); - -if (injected !== true) { - throw new Error("unexpected error while injecting import bundle"); -} - -// Display the text input that the user can enter their seedphrase into -setIframeDisplay("block"); - -// Once the user has entered their seedphrase, trigger this call to the iframe that -// 1) encrypts their seedphrase using the secure enclave's public key from the previous step -// 2) sends this ciphertext and a public key generated by the client to your page -const encryptedBundle = await iframeStamper.extractWalletEncryptedBundle(); - -// Now you can pass this encryptedBundle as a request to ACTIVITY_TYPE_IMPORT_WALLET. -``` - -## Documents - -- [IframeStamper](IframeStamper/readme) - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/modules.mdx b/generated-docs/sdks/modules.mdx deleted file mode 100644 index f6fcd91d7..000000000 --- a/generated-docs/sdks/modules.mdx +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: "Sdks" -mode: wide ---- - -# Documentation - -## Packages - -- [api-key-stamper - v0.4.4](api-key-stamper/readme) -- [cosmjs - v0.7.5](cosmjs/readme) -- [crypto - v2.3.1](crypto/readme) -- [eip-1193-provider - v3.3.5](eip-1193-provider/readme) -- [encoding - v0.4.0](encoding/readme) -- [ethers - v1.1.22](ethers/readme) -- [http - v3.0.0](http/readme) -- [iframe-stamper - v2.5.0](iframe-stamper/readme) -- [react-native-passkey-stamper - v1.0.10](react-native-passkey-stamper/readme) -- [sdk-browser - v4.0.0](sdk-browser/readme) -- [sdk-react - v4.2.2](sdk-react/readme) -- [sdk-react-native - v1.0.4](sdk-react-native/readme) -- [sdk-server - v3.0.1](sdk-server/readme) -- [solana - v1.0.21](solana/readme) -- [telegram-cloud-storage-stamper - v2.0.0](telegram-cloud-storage-stamper/readme) -- [viem - v0.7.2](viem/readme) -- [wallet-stamper - v1.0.3](wallet-stamper/readme) -- [webauthn-stamper - v0.5.0](webauthn-stamper/readme) diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/AuthenticatorTransport/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/AuthenticatorTransport/readme.mdx deleted file mode 100644 index d0516e751..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/AuthenticatorTransport/readme.mdx +++ /dev/null @@ -1,56 +0,0 @@ ---- -title: "AuthenticatorTransport" -mode: wide ---- - -# Enumeration: AuthenticatorTransport - -Defined in: [react-native-passkey-stamper/src/index.ts:21](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L21) - -## Enumeration Members - -### ble - -> **ble**: `"ble"` - -Defined in: [react-native-passkey-stamper/src/index.ts:24](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L24) - -*** - -### hybrid - -> **hybrid**: `"hybrid"` - -Defined in: [react-native-passkey-stamper/src/index.ts:26](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L26) - -*** - -### internal - -> **internal**: `"internal"` - -Defined in: [react-native-passkey-stamper/src/index.ts:27](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L27) - -*** - -### nfc - -> **nfc**: `"nfc"` - -Defined in: [react-native-passkey-stamper/src/index.ts:23](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L23) - -*** - -### smartCard - -> **smartCard**: `"smart-card"` - -Defined in: [react-native-passkey-stamper/src/index.ts:25](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L25) - -*** - -### usb - -> **usb**: `"usb"` - -Defined in: [react-native-passkey-stamper/src/index.ts:22](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L22) diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/PasskeyStamper/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/PasskeyStamper/readme.mdx deleted file mode 100644 index 887ad0a67..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/PasskeyStamper/readme.mdx +++ /dev/null @@ -1,102 +0,0 @@ ---- -title: "PasskeyStamper" -mode: wide ---- - -# Class: PasskeyStamper - -Defined in: [react-native-passkey-stamper/src/index.ts:205](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L205) - -Stamper to use with `@turnkey/http`'s `TurnkeyClient` - -## Constructors - -### Constructor - -> **new PasskeyStamper**(`config`): `PasskeyStamper` - -Defined in: [react-native-passkey-stamper/src/index.ts:214](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L214) - -#### Parameters - -##### config - -[`TPasskeyStamperConfig`](../TPasskeyStamperConfig/readme) - -#### Returns - -`PasskeyStamper` - -## Properties - -### allowCredentials - -> **allowCredentials**: [`PublicKeyCredentialDescriptor`](../PublicKeyCredentialDescriptor/readme)[] - -Defined in: [react-native-passkey-stamper/src/index.ts:209](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L209) - -*** - -### extensions - -> **extensions**: `Record`\<`string`, `unknown`\> - -Defined in: [react-native-passkey-stamper/src/index.ts:210](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L210) - -*** - -### forcePlatformKey - -> **forcePlatformKey**: `boolean` - -Defined in: [react-native-passkey-stamper/src/index.ts:211](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L211) - -*** - -### forceSecurityKey - -> **forceSecurityKey**: `boolean` - -Defined in: [react-native-passkey-stamper/src/index.ts:212](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L212) - -*** - -### rpId - -> **rpId**: `string` - -Defined in: [react-native-passkey-stamper/src/index.ts:206](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L206) - -*** - -### timeout - -> **timeout**: `number` - -Defined in: [react-native-passkey-stamper/src/index.ts:207](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L207) - -*** - -### userVerification - -> **userVerification**: `UserVerificationRequirement` - -Defined in: [react-native-passkey-stamper/src/index.ts:208](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L208) - -## Methods - -### stamp() - -> **stamp**(`payload`): `Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> - -Defined in: [react-native-passkey-stamper/src/index.ts:224](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L224) - -#### Parameters - -##### payload - -`string` - -#### Returns - -`Promise`\<\{ `stampHeaderName`: `string`; `stampHeaderValue`: `string`; \}\> diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/PublicKeyCredentialDescriptor/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/PublicKeyCredentialDescriptor/readme.mdx deleted file mode 100644 index 8c44e90dd..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/PublicKeyCredentialDescriptor/readme.mdx +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: "PublicKeyCredentialDescriptor" -mode: wide ---- - -# Interface: PublicKeyCredentialDescriptor - -Defined in: [react-native-passkey-stamper/src/index.ts:15](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L15) - -https://www.w3.org/TR/webauthn-2/#dictionary-credential-descriptor -Copied from https://github.com/f-23/react-native-passkey/blob/17184a1b1f6f3ac61e07aa784c9b64efb28b570e/src/Passkey.tsx#L80C1-L85C2 -TODO: can we import this type instead? - -## Properties - -### id - -> **id**: `string` - -Defined in: [react-native-passkey-stamper/src/index.ts:17](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L17) - -*** - -### transports? - -> `optional` **transports**: [`AuthenticatorTransport`](../AuthenticatorTransport/readme)[] - -Defined in: [react-native-passkey-stamper/src/index.ts:18](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L18) - -*** - -### type - -> **type**: `string` - -Defined in: [react-native-passkey-stamper/src/index.ts:16](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L16) diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/TPasskeyRegistrationConfig/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/TPasskeyRegistrationConfig/readme.mdx deleted file mode 100644 index 5f1a9361d..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/TPasskeyRegistrationConfig/readme.mdx +++ /dev/null @@ -1,126 +0,0 @@ ---- -title: "TPasskeyRegistrationConfig" -mode: wide ---- - -# Type Alias: TPasskeyRegistrationConfig - -> **TPasskeyRegistrationConfig** = `object` - -Defined in: [react-native-passkey-stamper/src/index.ts:41](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L41) - -## Properties - -### attestation? - -> `optional` **attestation**: `string` - -Defined in: [react-native-passkey-stamper/src/index.ts:87](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L87) - -*** - -### authenticatorName - -> **authenticatorName**: `string` - -Defined in: [react-native-passkey-stamper/src/index.ts:58](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L58) - -*** - -### authenticatorSelection? - -> `optional` **authenticatorSelection**: `object` - -Defined in: [react-native-passkey-stamper/src/index.ts:79](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L79) - -#### authenticatorAttachment? - -> `optional` **authenticatorAttachment**: `string` - -#### requireResidentKey? - -> `optional` **requireResidentKey**: `boolean` - -#### residentKey? - -> `optional` **residentKey**: `string` - -#### userVerification? - -> `optional` **userVerification**: `string` - -*** - -### challenge? - -> `optional` **challenge**: `string` - -Defined in: [react-native-passkey-stamper/src/index.ts:61](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L61) - -*** - -### excludeCredentials? - -> `optional` **excludeCredentials**: [`PublicKeyCredentialDescriptor`](../PublicKeyCredentialDescriptor/readme)[] - -Defined in: [react-native-passkey-stamper/src/index.ts:70](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L70) - -*** - -### extensions? - -> `optional` **extensions**: `Record`\<`string`, `unknown`\> - -Defined in: [react-native-passkey-stamper/src/index.ts:90](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L90) - -*** - -### rp - -> **rp**: `object` - -Defined in: [react-native-passkey-stamper/src/index.ts:44](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L44) - -#### id - -> **id**: `string` - -#### name - -> **name**: `string` - -*** - -### timeout? - -> `optional` **timeout**: `number` - -Defined in: [react-native-passkey-stamper/src/index.ts:64](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L64) - -*** - -### user - -> **user**: `object` - -Defined in: [react-native-passkey-stamper/src/index.ts:50](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L50) - -#### displayName - -> **displayName**: `string` - -#### id - -> **id**: `string` - -#### name - -> **name**: `string` - -*** - -### userVerification? - -> `optional` **userVerification**: `UserVerificationRequirement` - -Defined in: [react-native-passkey-stamper/src/index.ts:67](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L67) diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/TPasskeyStamperConfig/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/TPasskeyStamperConfig/readme.mdx deleted file mode 100644 index 49db21f5b..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/TPasskeyStamperConfig/readme.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: "TPasskeyStamperConfig" -mode: wide ---- - -# Type Alias: TPasskeyStamperConfig - -> **TPasskeyStamperConfig** = `object` - -Defined in: [react-native-passkey-stamper/src/index.ts:93](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L93) - -## Properties - -### allowCredentials? - -> `optional` **allowCredentials**: [`PublicKeyCredentialDescriptor`](../PublicKeyCredentialDescriptor/readme)[] - -Defined in: [react-native-passkey-stamper/src/index.ts:105](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L105) - -*** - -### extensions? - -> `optional` **extensions**: `Record`\<`string`, `unknown`\> - -Defined in: [react-native-passkey-stamper/src/index.ts:114](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L114) - -*** - -### rpId - -> **rpId**: `string` - -Defined in: [react-native-passkey-stamper/src/index.ts:96](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L96) - -*** - -### timeout? - -> `optional` **timeout**: `number` - -Defined in: [react-native-passkey-stamper/src/index.ts:99](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L99) - -*** - -### userVerification? - -> `optional` **userVerification**: `UserVerificationRequirement` - -Defined in: [react-native-passkey-stamper/src/index.ts:102](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L102) - -*** - -### withPlatformKey? - -> `optional` **withPlatformKey**: `boolean` - -Defined in: [react-native-passkey-stamper/src/index.ts:111](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L111) - -*** - -### withSecurityKey? - -> `optional` **withSecurityKey**: `boolean` - -Defined in: [react-native-passkey-stamper/src/index.ts:108](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L108) diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/TurnkeyAuthenticatorParams/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/TurnkeyAuthenticatorParams/readme.mdx deleted file mode 100644 index 3f41bceb5..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/TurnkeyAuthenticatorParams/readme.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: "TurnkeyAuthenticatorParams" -mode: wide ---- - -# Type Alias: TurnkeyAuthenticatorParams - -> **TurnkeyAuthenticatorParams** = `TurnkeyApiTypes`\[`"v1AuthenticatorParamsV2"`\] - -Defined in: [react-native-passkey-stamper/src/index.ts:33](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L33) - -Authenticator params expected by the Turnkey API (for authenticator, user, or sub-organization creation) diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/createPasskey/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/createPasskey/readme.mdx deleted file mode 100644 index 05cb38e25..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/createPasskey/readme.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: "CreatePasskey" -mode: wide ---- - -# Function: createPasskey() - -> **createPasskey**(`config`, `options`?): `Promise`\<\{\}\> - -Defined in: [react-native-passkey-stamper/src/index.ts:134](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L134) - -Creates a passkey and returns authenticator params - -## Parameters - -### config - -[`TPasskeyRegistrationConfig`](../TPasskeyRegistrationConfig/readme) - -### options? - -#### withPlatformKey - -`boolean` - -#### withSecurityKey - -`boolean` - -## Returns - -`Promise`\<\{\}\> diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/isSupported/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/isSupported/readme.mdx deleted file mode 100644 index 83138934c..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/isSupported/readme.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "IsSupported" -mode: wide ---- - -# Function: isSupported() - -> **isSupported**(): `boolean` - -Defined in: [react-native-passkey-stamper/src/index.ts:123](https://github.com/tkhq/sdk/blob/main/packages/react-native-passkey-stamper/src/index.ts#L123) - -Re-export of the underlying library's `isSupported` method - -## Returns - -`boolean` diff --git a/generated-docs/sdks/react-native-passkey-stamper/index/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/index/readme.mdx deleted file mode 100644 index e811328cc..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/index/readme.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Enumerations - -- [AuthenticatorTransport](AuthenticatorTransport/readme) - -## Classes - -- [PasskeyStamper](PasskeyStamper/readme) - -## Interfaces - -- [PublicKeyCredentialDescriptor](PublicKeyCredentialDescriptor/readme) - -## Type Aliases - -- [TPasskeyRegistrationConfig](TPasskeyRegistrationConfig/readme) -- [TPasskeyStamperConfig](TPasskeyStamperConfig/readme) -- [TurnkeyAuthenticatorParams](TurnkeyAuthenticatorParams/readme) - -## Functions - -- [createPasskey](createPasskey/readme) -- [isSupported](isSupported/readme) diff --git a/generated-docs/sdks/react-native-passkey-stamper/readme.mdx b/generated-docs/sdks/react-native-passkey-stamper/readme.mdx deleted file mode 100644 index 3ebc7306a..000000000 --- a/generated-docs/sdks/react-native-passkey-stamper/readme.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "React Native Passkey Stamper" -mode: wide ---- - -# @turnkey/react-native-passkey-stamper - -[![npm](https://img.shields.io/npm/v/@turnkey/react-native-passkey-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/react-native-passkey-stamper) - -This package contains a React Native passkey stamper. It uses [`react-native-passkey`](https://github.com/f-23/react-native-passkey) to do the heavy lifting. This stamper is meant to be used with [`@turnkey/http`](https://www.npmjs.com/package/@turnkey/http) - -## Installation - -- Install both [`react-native-passkey`](https://www.npmjs.com/package/react-native-passkey) and `@turnkey/react-native-passkey-stamper` (this package) in your React Native project. -- Set up provisioning correctly to make sure your app is signed (needed for passkey functionality) -- Serve an `apple-app-site-association` file from your domain to reference your application. See [more details here](https://github.com/f-23/react-native-passkey?tab=readme-ov-file#configuration) -- Add a new "Associated Domains" capability for web credentials (`webcredentials:your.site.com`) - -## Usage - -### Create a new passkey - -```ts -import { createPasskey } from "@turnkey/react-native-passkey-stamper"; - -// Returns authenticator params that can be used with sub-org creation, user creation, etc. -const authenticatorParams = await createPasskey({ - // Won't be visible to users, this is the name of the Turnkey resource - authenticatorName: "End-User Passkey", - rp: { - id: "your.site.com", - name: "Your App", - }, - user: { - // This ID isn't visible to users - id: String(Date.now()), - // ...but name and display names are. This is what's shown in the passkey prompt - name: "Some Name", - // displayName should be the same as "name" - displayName: "Some Name", - }, -}); -``` - -### Use an existing passkey - -```ts -import { PasskeyStamper } from "@turnkey/react-native-passkey-stamper"; -import { TurnkeyClient } from "@turnkey/http"; - -const stamper = new PasskeyStamper({ - rpId: "your.site.com", -}); - -// New HTTP client able to sign with passkeys! -const httpClient = new TurnkeyClient( - { baseUrl: "https://api.turnkey.com" }, - stamper -); - -// Now, send authenticated requests -httpClient.signTransaction(...) -``` - -## Demo app - -Head over to [this repository](https://github.com/r-n-o/passkeyapp/tree/main) for a fully functional React Native app built with Expo. - -## Documents - - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/react-wallet-kit/README.mdx b/generated-docs/sdks/react-wallet-kit/README.mdx deleted file mode 100644 index 93de7884a..000000000 --- a/generated-docs/sdks/react-wallet-kit/README.mdx +++ /dev/null @@ -1,123 +0,0 @@ ---- -title: "React Wallet Kit" -mode: wide ---- - -# @turnkey/react-wallet-kit - -The `@turnkey/react-wallet-kit` is a powerful SDK that allows you to integrate Turnkey's Embedded Wallets into your React applications. It provides a set of UI components and easy-to-use functions, all exported from a hook, enabling you to quickly build secure embedded wallet experiences. - -## Installation - -You can use `@turnkey/react-wallet-kit` in any React based web application. - -For this guide, let's create a new `Next.js` app. If you already have an existing app, you don't need to do this. - -```bash npx -npx create-next-app@latest -``` - -Now, install the Turnkey React Wallet Kit package: - - - -```bash npm -npm install @turnkey/react-wallet-kit -``` - -```bash pnpm -pnpm add @turnkey/react-wallet-kit -``` - -```bash yarn -yarn add @turnkey/react-wallet-kit -``` - - - -## Provider - -Wrap your app with the `TurnkeyProvider` component, and import `"@turnkey/react-wallet-kit/styles.css"` to include styles for the UI components. - -With Next.js App Router, keep `app/layout.tsx` as a server component and create a separate `app/providers.tsx` client wrapper. This is necessary if you want to pass callbacks (e.g., onError), which must be defined in a client component. - -```tsx app/providers.tsx -"use client"; - -import { - TurnkeyProvider, - TurnkeyProviderConfig, -} from "@turnkey/react-wallet-kit"; - -const turnkeyConfig: TurnkeyProviderConfig = { - organizationId: process.env.NEXT_PUBLIC_ORGANIZATION_ID!, - authProxyConfigId: process.env.NEXT_PUBLIC_AUTH_PROXY_CONFIG_ID!, -}; - -export function Providers({ children }: { children: React.ReactNode }) { - return {children}; -} -``` - -In case anything goes wrong, let's add an `onError` callback to the `TurnkeyProvider` to catch any errors that may occur. - -```tsx app/providers.tsx - console.error("Turnkey error:", error), - }} -> -``` - -Then, use the `Providers` component to wrap your app in `app/layout.tsx`. - -```tsx app/layout.tsx -import "@turnkey/react-wallet-kit/styles.css"; -import "./globals.css"; -import Providers from "./providers"; - -export default function RootLayout({ - children, -}: { - children: React.ReactNode; -}) { - return ( - - - {children} - - - ); -} -``` - -> **Why this pattern?** -> -> - Callbacks (and other interactive bits) must be declared in a client component. -> - Keeping layout.tsx as a server component maintains optimal rendering and avoids making your entire app client-side unnecessarily. -> - Centralizing Turnkey setup in app/providers.tsx keeps configuration, styles, and callbacks in one place. - -## Quick Authentication - -The easiest way to handle authentication is using the `handleLogin` function from the `useTurnkey` hook. This will automatically show a modal with all the authentication methods you've enabled in your dashboard. - -```tsx -import { useTurnkey } from "@turnkey/react-wallet-kit"; - -function LoginButton() { - const { handleLogin } = useTurnkey(); - - return ; -} -``` - -For more information, check out [our docs!](https://docs.turnkey.com) - -## Documents - - - -## Modules - -- [index](index/readme) diff --git a/generated-docs/sdks/react-wallet-kit/index/BaseWalletInterface/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/BaseWalletInterface/readme.mdx deleted file mode 100644 index e0b85d1c4..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/BaseWalletInterface/readme.mdx +++ /dev/null @@ -1,135 +0,0 @@ ---- -title: "BaseWalletInterface" -mode: wide ---- - -# Interface: BaseWalletInterface - -Defined in: core/dist/\_\_types\_\_/base.d.ts:437 - -Base interface for wallet functionalities common across different blockchain chains. - BaseWalletInterface - -## Properties - -### connectWalletAccount() - -> **connectWalletAccount**: (`provider`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:442 - -#### Parameters - -##### provider - -`WalletProvider` - -#### Returns - -`Promise`\<`void`\> - -*** - -### disconnectWalletAccount() - -> **disconnectWalletAccount**: (`provider`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:443 - -#### Parameters - -##### provider - -`WalletProvider` - -#### Returns - -`Promise`\<`void`\> - -*** - -### getProviders() - -> **getProviders**: () => `Promise`\<`WalletProvider`[]\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:441 - -#### Returns - -`Promise`\<`WalletProvider`[]\> - -*** - -### getPublicKey() - -> **getPublicKey**: (`provider`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:440 - -Retrieves the public key as a string. - -#### Parameters - -##### provider - -`WalletProvider` - -#### Returns - -`Promise`\<`string`\> - -*** - -### interfaceType - -> **interfaceType**: `WalletInterfaceType` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:438 - -*** - -### sign() - -> **sign**: (`payload`, `provider`, `intent`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:439 - -#### Parameters - -##### payload - -`string` - -##### provider - -`WalletProvider` - -##### intent - -`SignIntent` - -#### Returns - -`Promise`\<`string`\> - -*** - -### switchChain()? - -> `optional` **switchChain**: (`provider`, `chainOrId`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:444 - -#### Parameters - -##### provider - -`WalletProvider` - -##### chainOrId - -`string` | `SwitchableChain` - -#### Returns - -`Promise`\<`void`\> diff --git a/generated-docs/sdks/react-wallet-kit/index/ClientContextType/README.mdx b/generated-docs/sdks/react-wallet-kit/index/ClientContextType/README.mdx deleted file mode 100644 index 51f785470..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/ClientContextType/README.mdx +++ /dev/null @@ -1,4020 +0,0 @@ ---- -title: "ClientContextType" -mode: wide ---- - -# Interface: ClientContextType - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:40](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L40) - -## Extends - -- `TurnkeyClientMethods` - -## Properties - -### addOauthProvider() - -> **addOauthProvider**: (`params`) => `Promise`\<`string`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:658 - -Adds an OAuth provider to the user. - -- This function adds an OAuth provider (e.g., Google, Apple) to the user account. -- If a userId is provided, it adds the provider for that specific user; otherwise, it uses the current session's userId. -- Automatically checks if an account already exists for the provided OIDC token and prevents duplicate associations. -- If the user's email is not set or not verified, attempts to update and verify the email using the email from the OIDC token. -- Handles session management and error reporting for the add provider flow. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### oidcToken - -`string` - -OIDC token for the OAuth provider. - -###### providerName - -`string` - -name of the OAuth provider to add (e.g., "Google", "Apple"). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to add the provider for a specific user (defaults to current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of provider IDs associated with the user. - -#### Throws - -If there is no active session, if the account already exists, or if there is an error adding the OAuth provider. - -#### Inherited from - -`TurnkeyClientMethods.addOauthProvider` - -*** - -### addPasskey() - -> **addPasskey**: (`params?`) => `Promise`\<`string`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:700 - -Adds a new passkey authenticator for the user. - -- This function prompts the user to create a new passkey (WebAuthn/FIDO2) and adds it as an authenticator for the user. -- Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow. -- If a userId is provided, the passkey is added for that specific user; otherwise, it uses the current session's userId. -- The passkey's name and display name can be customized; if not provided, defaults are generated. -- The resulting passkey attestation and challenge are registered with Turnkey as a new authenticator. - -#### Parameters - -##### params? - -###### displayName? - -`string` - -display name of the passkey (defaults to the value of `name`). - -###### name? - -`string` - -name of the passkey (defaults to "Turnkey Passkey-`timestamp`"). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to add the passkey for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of authenticator IDs for the newly added passkey(s). - -#### Throws - -If there is no active session, if passkey creation fails, or if there is an error adding the passkey. - -#### Inherited from - -`TurnkeyClientMethods.addPasskey` - -*** - -### allSessions? - -> `optional` **allSessions**: `Record`\<`string`, [`Session`](../../../sdk-browser/index/Session/readme)\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:43](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L43) - -*** - -### authState - -> **authState**: `AuthState` - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:45](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L45) - -*** - -### clearAllSessions() - -> **clearAllSessions**: () => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:958 - -Clears all sessions and resets the active session state. - -- This function removes all session data from the client and persistent storage, including all associated key pairs. -- Iterates through all stored session keys, clearing each session and deleting its corresponding API key pair. -- After clearing, there will be no active session, and all session-related data will be removed from local storage. -- Throws an error if no sessions exist or if there is an error during the clearing process. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when all sessions are successfully cleared. - -#### Throws - -If no sessions exist or if there is an error clearing all sessions. - -#### Inherited from - -`TurnkeyClientMethods.clearAllSessions` - -*** - -### clearSession() - -> **clearSession**: (`params?`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:944 - -Clears the session associated with the specified session key, or the active session by default. - -- This function deletes the session and its associated key pair from storage. -- If a sessionKey is provided, it will clear the session under that key; otherwise, it will clear the default (active) session. -- Removes the session data from local storage and deletes the corresponding API key pair from the key store. -- Throws an error if the session does not exist or if there is an error during the clearing process. - -#### Parameters - -##### params? - -###### sessionKey? - -`string` - -session key to clear the session under (defaults to the default session key). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the session is successfully cleared. - -#### Throws - -If the session does not exist or if there is an error clearing the session. - -#### Inherited from - -`TurnkeyClientMethods.clearSession` - -*** - -### clearUnusedKeyPairs() - -> **clearUnusedKeyPairs**: () => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:1048 - -Clears any unused API key pairs from persistent storage. - -- This function scans all API key pairs stored in indexedDB and removes any key pairs that are not associated with a session in persistent storage. -- Ensures that only key pairs referenced by existing sessions are retained, preventing orphaned or stale key pairs from accumulating. -- Iterates through all stored session keys and builds a map of in-use public keys, then deletes any key pairs not present in this map. -- Intended to be called after session changes (e.g., login, logout, session replacement) to keep key storage clean and secure. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when all unused key pairs are successfully cleared. - -#### Throws - -If there is an error listing, checking, or deleting unused key pairs. - -#### Inherited from - -`TurnkeyClientMethods.clearUnusedKeyPairs` - -*** - -### clientState - -> **clientState**: `undefined` \| `ClientState` - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:44](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L44) - -*** - -### completeOauth() - -> **completeOauth**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:348 - -Completes the OAuth authentication flow by either signing up or logging in the user, depending on whether a sub-organization already exists for the provided OIDC token. - -- This function first checks if there is an existing sub-organization associated with the OIDC token. -- If a sub-organization exists, it proceeds with the OAuth login flow. -- If no sub-organization exists, it creates a new sub-organization and completes the sign-up flow. -- Optionally accepts a custom OAuth provider name, session key, and additional sub-organization creation parameters. -- Handles session storage and management, and supports invalidating existing sessions if specified. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../CreateSubOrgParams/readme) - -parameters for sub-organization creation (e.g., authenticators, user metadata). - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing sessions for the user. - -###### oidcToken - -`string` - -OIDC token received after successful authentication with the OAuth provider. - -###### providerName? - -`string` - -name of the OAuth provider (defaults to a generated name with a timestamp). - -###### publicKey - -`string` - -public key to use for authentication. Must be generated prior to calling this function. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the user. - -#### Throws - -If there is an error during the OAuth completion process, such as account lookup, sign-up, or login. - -#### Inherited from - -`TurnkeyClientMethods.completeOauth` - -*** - -### completeOtp() - -> **completeOtp**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:320 - -Completes the OTP authentication flow by verifying the OTP code and then either signing up or logging in the user. - -- This function first verifies the OTP code for the provided contact and OTP type. -- If the contact is not associated with an existing sub-organization, it will automatically create a new sub-organization and complete the sign-up flow. -- If the contact is already associated with a sub-organization, it will complete the login flow. -- Supports passing a custom public key for authentication, invalidating existing session, specifying a session key, and providing additional sub-organization creation parameters. -- Handles both email and SMS OTP types. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../CreateSubOrgParams/readme) - -parameters for sub-organization creation (e.g., authenticators, user metadata). - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing sessions for the user. - -###### otpCode - -`string` - -OTP code entered by the user. - -###### otpId - -`string` - -ID of the OTP to complete (returned from `initOtp`). - -###### otpType - -[`OtpType`](../OtpType/readme) - -type of OTP being completed (OtpType.Email or OtpType.Sms). - -###### publicKey? - -`string` - -public key to use for authentication. If not provided, a new key pair may be generated. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the user. - -#### Throws - -If there is an error during OTP verification, sign-up, or login. - -#### Inherited from - -`TurnkeyClientMethods.completeOtp` - -*** - -### config? - -> `optional` **config**: `TurnkeyProviderConfig` - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:46](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L46) - -*** - -### connectWalletAccount() - -> **connectWalletAccount**: (`walletProvider`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:119 - -Connects the specified wallet account. - -- Requires the wallet manager and its connector to be initialized. - -#### Parameters - -##### walletProvider - -`WalletProvider` - -wallet provider to connect. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves once the wallet account is connected. - -#### Throws - -If the wallet manager is uninitialized or the connection fails. - -#### Inherited from - -`TurnkeyClientMethods.connectWalletAccount` - -*** - -### createApiKeyPair() - -> **createApiKeyPair**: (`params?`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:1063 - -Creates a new API key pair and returns the public key. - -- This function generates a new API key pair and stores it in the underlying key store (IndexedDB). -- If an external key pair is provided, it will use that key pair for creation instead of generating a new one. -- If `storeOverride` is set to true, the generated or provided public key will be set as the override key in the API key stamper, making it the active key for subsequent signing operations. -- Ensures the API key stamper is initialized before proceeding. -- Handles both native CryptoKeyPair objects and raw key material. - -#### Parameters - -##### params? - -###### externalKeyPair? - -`CryptoKeyPair` \| \{ `privateKey`: `string`; `publicKey`: `string`; \} - -An externally generated key pair (either a CryptoKeyPair or an object with publicKey/privateKey strings) to use instead of generating a new one. - -###### storeOverride? - -`boolean` - -If true, sets the generated or provided public key as the override key in the API key stamper (defaults to false). -@returnparams.s A promise that resolves to the public key of the created or provided API key pair as a string. - -#### Returns - -`Promise`\<`string`\> - -#### Throws - -If the API key stamper is not initialized or if there is an error during key pair creation or storage. - -#### Inherited from - -`TurnkeyClientMethods.createApiKeyPair` - -*** - -### createPasskey() - -> **createPasskey**: (`params?`) => `Promise`\<\{ `attestation`: [`v1Attestation`](../../../_turnkey/sdk-types/v1Attestation/readme); `encodedChallenge`: `string`; \}\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:35 - -Creates a new passkey authenticator for the user. - -- This function generates a new passkey attestation and challenge, suitable for registration with the user's device. -- Handles both web and React Native environments, automatically selecting the appropriate passkey creation flow. -- The resulting attestation and challenge can be used to register the passkey with Turnkey. - -#### Parameters - -##### params? - -###### displayName? - -`string` - -display name for the passkey. If not provided, defaults to "A Passkey". - -###### name? - -`string` - -name of the passkey. If not provided, defaults to "A Passkey". - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Returns - -`Promise`\<\{ `attestation`: [`v1Attestation`](../../../_turnkey/sdk-types/v1Attestation/readme); `encodedChallenge`: `string`; \}\> - -A promise that resolves to an object containing: - - attestation: attestation object returned from the passkey creation process. - - encodedChallenge: encoded challenge string used for passkey registration. - -#### Throws - -If there is an error during passkey creation, or if the platform is unsupported. - -#### Inherited from - -`TurnkeyClientMethods.createPasskey` - -*** - -### createWallet() - -> **createWallet**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:745 - -Creates a new wallet for sub-organization. - -- This function creates a new wallet for the current sub-organization. -- If an organizationId is provided, the wallet will be created under that specific sub-organization; otherwise, it uses the current session's organizationId. -- If a list of address formats is provided, accounts will be created in the wallet based on those formats (starting from path index 0). -- If a list of account parameters is provided, those accounts will be created in the wallet. -- If no accounts or address formats are provided, default Ethereum and Solana accounts will be created. -- Optionally allows specifying the mnemonic length for the wallet seed phrase (defaults to 12). -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### accounts? - -[`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme)[] \| [`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] - -array of account parameters or address formats to create in the wallet. - -###### mnemonicLength? - -`number` - -mnemonic length for the wallet seed phrase (defaults to 12). - -###### organizationId? - -`string` - -organization ID to create the wallet under a specific sub-organization (defaults to the current session's organizationId). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### walletName - -`string` - -name of the wallet to create. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the ID of the newly created wallet. - -#### Throws - -If there is no active session or if there is an error creating the wallet. - -#### Inherited from - -`TurnkeyClientMethods.createWallet` - -*** - -### createWalletAccounts() - -> **createWalletAccounts**: (`params`) => `Promise`\<`string`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:769 - -Creates new accounts in the specified wallet. - -- This function creates new wallet accounts based on the provided account parameters or address formats. -- If a walletId is provided, it creates the accounts in that specific wallet; otherwise, it uses the current session's wallet. -- If a list of address formats is provided, it will create accounts in the wallet based on those formats, automatically determining the next available path indexes to avoid duplicates with existing accounts. -- If account parameters are provided, they are used directly for account creation. -- Automatically queries existing wallet accounts to prevent duplicate account creation for the same address format and path. -- Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### accounts - -[`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme)[] \| [`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] - -An array of account parameters or address formats to create in the wallet. - -###### organizationId? - -`string` - -organization ID to create the accounts under a specific organization (walletId must be associated with the sub-organization). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### walletId - -`string` - -ID of the wallet to create accounts in. - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of addresses for the newly created accounts. - -#### Throws - -If there is no active session, if the wallet does not exist, or if there is an error creating the wallet accounts. - -#### Inherited from - -`TurnkeyClientMethods.createWalletAccounts` - -*** - -### deleteSubOrganization() - -> **deleteSubOrganization**: (`params?`) => `Promise`\<[`TDeleteSubOrganizationResponse`](../../../_turnkey/sdk-types/TDeleteSubOrganizationResponse/readme)\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:910 - -Deletes the current sub-organization (sub-org) for the active session. - -- This function deletes the sub-organization associated with the current active session. -- By default, the deletion will fail if any wallets associated with the sub-organization have not been exported. -- If `deleteWithoutExport` is set to true, the sub-organization will be deleted even if its wallets have not been exported (potentially resulting in loss of access to those wallets). -- Requires an active session; otherwise, an error is thrown. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### deleteWithoutExport? - -`boolean` - -flag to delete the sub-organization without requiring all wallets to be exported first (defaults to false). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper. - -#### Returns - -`Promise`\<[`TDeleteSubOrganizationResponse`](../../../_turnkey/sdk-types/TDeleteSubOrganizationResponse/readme)\> - -A promise that resolves to a `TDeleteSubOrganizationResponse` object containing the result of the deletion. - -#### Throws - -If there is no active session or if there is an error deleting the sub-organization. - -#### Inherited from - -`TurnkeyClientMethods.deleteSubOrganization` - -*** - -### disconnectWalletAccount() - -> **disconnectWalletAccount**: (`walletProvider`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:129 - -Disconnects the specified wallet account. - -- Requires the wallet manager and its connector to be initialized. - -#### Parameters - -##### walletProvider - -`WalletProvider` - -wallet provider to disconnect. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves once the wallet account is disconnected. - -#### Throws - -If the wallet manager is uninitialized or the disconnection fails. - -#### Inherited from - -`TurnkeyClientMethods.disconnectWalletAccount` - -*** - -### exportPrivateKey() - -> **exportPrivateKey**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:814 - -Exports a private key as an encrypted bundle. - -- This function exports the specified private key as an encrypted bundle, suitable for backup or transfer. -- The exported bundle contains the private key's key material, encrypted to the provided target public key. -- If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown. -- If an organizationId is provided, the private key will be exported under that sub-organization; otherwise, the current session's organizationId is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### organizationId? - -`string` - -organization ID to export the private key under a specific sub - -###### privateKeyId - -`string` - -ID of the private key to export. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### targetPublicKey - -`string` - -public key to encrypt the bundle to (required). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to an `ExportBundle` object containing the encrypted private key and metadata. - -#### Throws - -If there is no active session, if the targetPublicKey is missing, or if there is an error exporting the private key. - -#### Inherited from - -`TurnkeyClientMethods.exportPrivateKey` - -*** - -### exportWallet() - -> **exportWallet**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:792 - -Exports a wallet as an encrypted bundle. - -- This function exports the specified wallet and its accounts as an encrypted bundle, suitable for backup or transfer. -- The exported bundle contains the wallet's seed phrase, encrypted to the provided target public key. -- If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown. -- If an organizationId is provided, the wallet will be exported under that sub-organization; otherwise, the current session's organizationId is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- The exported bundle can later be imported using the `importWallet` method. - -#### Parameters - -##### params - -###### organizationId? - -`string` - -organization ID to export the wallet under a specific sub-organization (walletId must be associated with the sub-organization). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### targetPublicKey - -`string` - -public key to encrypt the bundle to (required). - -###### walletId - -`string` - -ID of the wallet to export. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to an `ExportBundle` object containing the encrypted wallet seed phrase and metadata. - -#### Throws - -If there is no active session, if the targetPublicKey is missing, or if there is an error exporting the wallet. - -#### Inherited from - -`TurnkeyClientMethods.exportWallet` - -*** - -### exportWalletAccount() - -> **exportWalletAccount**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:837 - -Exports a wallet account as an encrypted bundle. - -- This function exports the specified wallet account as an encrypted bundle, suitable for backup or transfer. -- The exported bundle contains the wallet account's key material, encrypted to the provided target public key. -- If a targetPublicKey is provided, the bundle will be encrypted to that public key; otherwise, an error will be thrown. -- If an organizationId is provided, the wallet account will be exported under that sub-organization; otherwise, the current session's organizationId is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### address - -`string` - -address of the wallet account to export. - -###### organizationId? - -`string` - -organization ID to export the wallet account under a specific sub-organization. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### targetPublicKey - -`string` - -public key to encrypt the bundle to. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to an `ExportBundle` object containing the encrypted wallet account and metadata. - -#### Throws - -If there is no active session, if the targetPublicKey is missing, or if there is an error exporting the wallet account. - -#### Inherited from - -`TurnkeyClientMethods.exportWalletAccount` - -*** - -### fetchUser() - -> **fetchUser**: (`params?`) => `Promise`\<[`v1User`](../../../_turnkey/sdk-types/v1User/readme)\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:538 - -Fetches the user details for the current session or a specified user. - -- Retrieves user details from the Turnkey API using the provided userId and organizationId, or defaults to those from the active session. -- If no userId is provided, the userId from the current session is used. -- If no organizationId is provided, the organizationId from the current session is used. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Ensures that an active session exists before making the request. - -#### Parameters - -##### params? - -###### organizationId? - -`string` - -organization ID to specify the sub-organization (defaults to the current session's organizationId). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to fetch specific user details (defaults to the current session's userId). - -#### Returns - -`Promise`\<[`v1User`](../../../_turnkey/sdk-types/v1User/readme)\> - -A promise that resolves to a `v1User` object containing the user details. - -#### Throws - -If there is no active session, if there is no userId, or if there is an error fetching user details. - -#### Inherited from - -`TurnkeyClientMethods.fetchUser` - -*** - -### fetchWalletAccounts() - -> **fetchWalletAccounts**: (`params`) => `Promise`\<`WalletAccount`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:432 - -Fetches all accounts for a specific wallet, including both embedded and connected wallet accounts. - -- For embedded wallets, retrieves accounts from the Turnkey API, supporting pagination (defaults to the first page with a limit of 100 accounts). -- For connected wallets (e.g., browser extensions or external providers), constructs account objects for each connected address from the provided or discovered wallet providers. -- Automatically determines the account type and populates relevant fields such as address, curve, and signing capability. -- Optionally allows filtering by a specific set of wallet providers and supports custom pagination options. -- Supports stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### paginationOptions? - -[`v1Pagination`](../../../_turnkey/sdk-types/v1Pagination/readme) - -pagination options for embedded wallets. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### wallet - -`Wallet` - -wallet for which to fetch accounts. - -###### walletProviders? - -`WalletProvider`[] - -list of wallet providers to filter by (used for connected wallets). - -#### Returns - -`Promise`\<`WalletAccount`[]\> - -A promise that resolves to an array of `v1WalletAccount` objects. - -#### Throws - -If no active session is found or if there is an error fetching wallet accounts. - -#### Inherited from - -`TurnkeyClientMethods.fetchWalletAccounts` - -*** - -### fetchWallets() - -> **fetchWallets**: (`params?`) => `Promise`\<`Wallet`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:413 - -Fetches all wallets for the current user, including both embedded and connected wallets. - -- Retrieves all wallets associated with the organizationId from the current active session. -- For each embedded wallet, automatically fetches and attaches all associated wallet accounts. -- For connected wallets (e.g., browser extensions or external providers), groups providers by wallet name and attaches all connected accounts. -- Returns both embedded and connected wallets in a single array, each with their respective accounts populated. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Returns - -`Promise`\<`Wallet`[]\> - -A promise that resolves to an array of `Wallet` objects. - -#### Throws - -If no active session is found or if there is an error fetching wallets. - -#### Inherited from - -`TurnkeyClientMethods.fetchWallets` - -*** - -### getActiveSessionKey() - -> **getActiveSessionKey**: () => `Promise`\<`undefined` \| `string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:1036 - -Retrieves the active session key currently set in persistent storage. - -- This function fetches the session key that is currently marked as active in the client's persistent storage. -- The active session key determines which session is used for all session-dependent operations. -- If no active session key is set, returns `undefined`. -- Useful for determining which session is currently in use, especially when managing multiple sessions. - -#### Returns - -`Promise`\<`undefined` \| `string`\> - -A promise that resolves to the active session key as a string, or `undefined` if no active session is set. - -#### Throws - -If there is an error retrieving the active session key from storage. - -#### Inherited from - -`TurnkeyClientMethods.getActiveSessionKey` - -*** - -### getAllSessions() - -> **getAllSessions**: () => `Promise`\<`undefined` \| `Record`\<`string`, [`Session`](../../../sdk-browser/index/Session/readme)\>\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:1009 - -Retrieves all sessions stored in persistent storage. - -- This function fetches all session objects currently stored by the client, including those that are not active. -- Returns a record mapping each session key to its corresponding `Session` object. -- Useful for session management, auditing, or displaying all available sessions to the user. -- Automatically skips any session keys that do not have a valid session object. - -#### Returns - -`Promise`\<`undefined` \| `Record`\<`string`, [`Session`](../../../sdk-browser/index/Session/readme)\>\> - -A promise that resolves to a record of session keys and their corresponding `Session` objects, or `undefined` if no sessions exist. - -#### Throws - -If there is an error retrieving sessions from storage. - -#### Inherited from - -`TurnkeyClientMethods.getAllSessions` - -*** - -### getProxyAuthConfig() - -> **getProxyAuthConfig**: () => `Promise`\<[`ProxyTGetWalletKitConfigResponse`](../../../_turnkey/sdk-types/ProxyTGetWalletKitConfigResponse/readme)\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:1081 - -Fetches the WalletKit proxy authentication configuration from the auth proxy. - -- This function makes a request to the Turnkey auth proxy to retrieve the current WalletKit configuration, - including supported authentication methods, OAuth providers, and any custom proxy settings. -- Useful for dynamically configuring the client UI or authentication flows based on the proxy's capabilities. -- Ensures that the client is aware of the latest proxy-side configuration, which may affect available login/signup options. - -#### Returns - -`Promise`\<[`ProxyTGetWalletKitConfigResponse`](../../../_turnkey/sdk-types/ProxyTGetWalletKitConfigResponse/readme)\> - -A promise that resolves to a `ProxyTGetWalletKitConfigResponse` object containing the proxy authentication configuration. - -#### Throws - -If there is an error retrieving the proxy authentication configuration from the auth proxy. - -#### Inherited from - -`TurnkeyClientMethods.getProxyAuthConfig` - -*** - -### getSession() - -> **getSession**: (`params?`) => `Promise`\<`undefined` \| [`Session`](../../../sdk-browser/index/Session/readme)\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:995 - -Retrieves the session associated with the specified session key, or the active session by default. - -- This function retrieves the session object from storage, using the provided session key or, if not specified, the current active session key. -- If no session key is provided and there is no active session, it returns undefined. -- Returns the session details, including public key, organization ID, user ID, and expiration. - -#### Parameters - -##### params? - -###### sessionKey? - -`string` - -session key to retrieve a specific session (defaults to the current active session key). - -#### Returns - -`Promise`\<`undefined` \| [`Session`](../../../sdk-browser/index/Session/readme)\> - -A promise that resolves to a `Session` object containing the session details, or undefined if not found. - -#### Throws - -If there is an error retrieving the session from storage. - -#### Inherited from - -`TurnkeyClientMethods.getSession` - -*** - -### getWalletProviders() - -> **getWalletProviders**: (`chain?`) => `Promise`\<`WalletProvider`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:109 - -Retrieves wallet providers from the initialized wallet manager. - -- Optionally filters providers by the specified blockchain chain. -- Throws an error if the wallet manager is not initialized. - -#### Parameters - -##### chain? - -`Chain` - -optional blockchain chain to filter the returned providers. - -#### Returns - -`Promise`\<`WalletProvider`[]\> - -A promise that resolves to an array of wallet providers. - -#### Throws - -If the wallet manager is uninitialized or provider retrieval fails. - -#### Inherited from - -`TurnkeyClientMethods.getWalletProviders` - -*** - -### handleAddEmail() - -> **handleAddEmail**: (`params?`) => `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:399](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L399) - -Handles the add user email flow. - -- This function opens a modal with the UpdateEmail component, using a modified title and flow for adding and verifying the user's email address. -- If an email is provided, it will immediately send an OTP request to the user and display the OTP verification modal. -- Supports both manual entry and pre-filled email addresses, as well as custom modal titles and subtitles. -- Uses the addEmailContinue helper to manage the OTP flow, verification, and update logic. -- After successful verification and update, the user details state is refreshed and an optional success page can be shown. -- Supports customizing the duration of the success page after update. -- Handles all error cases and throws a TurnkeyError with appropriate error codes. - -#### Parameters - -##### params? - -###### email? - -`string` - -parameter to specify the new email address. - -###### subTitle? - -`string` - -subtitle for the modal. - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after update (default: 0, no success page). - -###### title? - -`string` - -title for the modal (defaults to "Connect an email" if the user does not have an email). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user that was changed. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error adding the email. - -*** - -### handleUpdateUserName() - -> **handleUpdateUserName**: (`params?`) => `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:373](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L373) - -Handles the update user email flow. - -- This function opens a modal with the UpdateEmail component for updating and verifying the user's email address. -- If an email is provided, it will immediately send an OTP request to the user and display the OTP verification modal. -- Supports both manual entry and pre-filled email addresses, as well as custom modal titles and subtitles. -- Uses the updateEmailContinue helper to manage the OTP flow, verification, and update logic. -- After successful verification and update, the user details state is refreshed and an optional success page can be shown. -- Supports customizing the duration of the success page after update. -- Handles all error cases and throws a TurnkeyError with appropriate error codes. - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to specify the stamper to use for the update (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### subTitle? - -`string` - -subtitle for the modal. - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after update (default: 0, no success page). - -###### title? - -`string` - -title for the modal. - -###### userName? - -`string` - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user that was changed. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error updating the email. - -*** - -### httpClient - -> **httpClient**: `undefined` \| `TurnkeySDKClientBase` - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:41](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L41) - -*** - -### importPrivateKey() - -> **importPrivateKey**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:888 - -Imports a private key from an encrypted bundle. - -- This function imports a private key using the provided encrypted bundle. -- If a userId is provided, the private key will be imported for that specific user; otherwise, it uses the current session's userId. -- Requires address formats to -- Automatically infers the cryptographic curve used to generate the private key based on the address format (can be optionally overriden if needed). -- The encrypted bundle MUST be encrypted to ensure security. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### addressFormats - -[`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme)[] - -###### curve - -[`v1Curve`](../../../_turnkey/sdk-types/v1Curve/readme) - -the cryptographic curve used to generate a given private key - -###### encryptedBundle - -`string` - -encrypted bundle containing the private key key material and metadata. - -###### privateKeyName - -`string` - -name of the private key to create upon import. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to import the wallet for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the ID of the imported wallet. - -#### Throws - -If there is no active session, if the encrypted bundle is invalid, or if there is an error importing the wallet. - -#### Inherited from - -`TurnkeyClientMethods.importPrivateKey` - -*** - -### importWallet() - -> **importWallet**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:861 - -Imports a wallet from an encrypted bundle. - -- This function imports a wallet using the provided encrypted bundle and creates accounts based on the provided parameters. -- If a userId is provided, the wallet will be imported for that specific user; otherwise, it uses the current session's userId. -- If an accounts array is provided, those accounts will be created in the imported wallet; otherwise, default Ethereum and Solana accounts will be created. -- The encrypted bundle MUST be encrypted to -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### accounts? - -[`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] - -array of account parameters to create in the imported wallet (defaults to standard Ethereum and Solana accounts). - -###### encryptedBundle - -`string` - -encrypted bundle containing the wallet seed phrase and metadata. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to import the wallet for a specific user (defaults to the current session's userId). - -###### walletName - -`string` - -name of the wallet to create upon import. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the ID of the imported wallet. - -#### Throws - -If there is no active session, if the encrypted bundle is invalid, or if there is an error importing the wallet. - -#### Inherited from - -`TurnkeyClientMethods.importWallet` - -*** - -### initOtp() - -> **initOtp**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:222 - -Initializes the OTP process by sending an OTP code to the provided contact. - -- This function initiates the OTP flow by sending a one-time password (OTP) code to the user's contact information (email address or phone number) via the auth proxy. -- Supports both email and SMS OTP types. -- Returns an OTP ID that is required for subsequent OTP verification. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### otpType - -[`OtpType`](../OtpType/readme) - -type of OTP to initialize (OtpType.Email or OtpType.Sms). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the OTP ID required for verification. - -#### Throws - -If there is an error during the OTP initialization process or if the maximum number of OTPs has been reached. - -#### Inherited from - -`TurnkeyClientMethods.initOtp` - -*** - -### loginOrSignupWithWallet() - -> **loginOrSignupWithWallet**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:204 - -Logs in an existing user or signs up a new user using a wallet, creating a new sub-organization if needed. - -- This function attempts to log in the user by stamping a login request with the provided wallet. -- If the wallet’s public key is not associated with an existing sub-organization, a new one is created. -- Handles both wallet authentication and sub-organization creation in a single flow. -- For Ethereum wallets, derives the public key from the signed request header; for Solana wallets, retrieves it directly from the wallet. -- Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration. -- Stores the resulting session token under the specified session key, or the default session key if not provided. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../CreateSubOrgParams/readme) - -optional parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### sessionKey? - -`string` - -session key to use for storing the session (defaults to the default session key). - -###### walletProvider - -`WalletProvider` - -wallet provider to use for authentication. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the sub-organization (new or existing). - -#### Throws - -If there is an error during wallet authentication, sub-organization creation, or session storage. - -#### Inherited from - -`TurnkeyClientMethods.loginOrSignupWithWallet` - -*** - -### loginWithOauth() - -> **loginWithOauth**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:371 - -Logs in a user using OAuth authentication. - -- This function logs in a user using the provided OIDC token and public key. -- Optionally invalidates any existing sessions for the user if `invalidateExisting` is set to true. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Handles cleanup of unused key pairs if login fails. - -#### Parameters - -##### params - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing sessions for the user. - -###### oidcToken - -`string` - -OIDC token received after successful authentication with the OAuth provider. - -###### publicKey - -`string` - -public key to use for authentication. Must be generated prior to calling this function. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token. - -#### Throws - -If there is an error during the OAuth login process or if key pair cleanup fails. - -#### Inherited from - -`TurnkeyClientMethods.loginWithOauth` - -*** - -### loginWithOtp() - -> **loginWithOtp**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:268 - -Logs in a user using an OTP verification token. - -- This function logs in a user using the verification token received after OTP verification (from email or SMS). -- If a public key is not provided, a new API key pair will be generated for authentication. -- Optionally invalidates any existing sessions for the user if `invalidateExisting` is set to true. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Handles cleanup of unused key pairs if login fails. - -#### Parameters - -##### params - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing session for the user. - -###### publicKey? - -`string` - -public key to use for authentication. If not provided, a new key pair will be generated. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -###### verificationToken - -`string` - -verification token received after OTP verification. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token. - -#### Throws - -If there is an error during the OTP login process or if key pair cleanup fails. - -#### Inherited from - -`TurnkeyClientMethods.loginWithOtp` - -*** - -### loginWithPasskey() - -> **loginWithPasskey**: (`params?`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:72 - -Logs in a user using a passkey, optionally specifying the public key, session key, and session expiration. - -- This function initiates the login process with a passkey and handles session creation and storage. -- If a public key is not provided, a new key pair will be generated for authentication. -- If a session key is not provided, the default session key will be used. -- The session expiration can be customized via the expirationSeconds parameter. -- Handles cleanup of unused key pairs if login fails. - -#### Parameters - -##### params? - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### publicKey? - -`string` - -public key to use for authentication. If not provided, a new key pair will be generated. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token. - -#### Throws - -If there is an error during the passkey login process or if the user cancels the passkey prompt. - -#### Inherited from - -`TurnkeyClientMethods.loginWithPasskey` - -*** - -### loginWithWallet() - -> **loginWithWallet**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:159 - -Logs in a user using the specified wallet provider. - -- This function logs in a user by authenticating with the provided wallet provider via a wallet-based signature. -- If a public key is not provided, a new one will be generated for authentication. -- Optionally accepts a custom session key and session expiration time. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Throws an error if a public key cannot be found or generated, or if the login process fails. - -#### Parameters - -##### params - -###### expirationSeconds? - -`string` - -optional session expiration time in seconds (defaults to the configured default). - -###### publicKey? - -`string` - -optional public key to associate with the session (generated if not provided). - -###### sessionKey? - -`string` - -optional key to store the session under (defaults to the default session key). - -###### walletProvider - -`WalletProvider` - -wallet provider to use for authentication. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the created session token. - -#### Throws - -If the wallet stamper is uninitialized, a public key cannot be found or generated, or login fails. - -#### Inherited from - -`TurnkeyClientMethods.loginWithWallet` - -*** - -### logout() - -> **logout**: (`params?`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:54 - -Logs out the current client session. - -- This function clears the specified session and removes any associated key pairs from storage. -- If a sessionKey is provided, it logs out from that session; otherwise, it logs out from the active session. -- Cleans up any api keys associated with the session. - -#### Parameters - -##### params? - -###### sessionKey? - -`string` - -session key to specify which session to log out from (defaults to the active session). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the logout process is complete. - -#### Throws - -If there is no active session or if there is an error during the logout process. - -#### Inherited from - -`TurnkeyClientMethods.logout` - -*** - -### refreshSession() - -> **refreshSession**: (`params?`) => `Promise`\<`undefined` \| [`TStampLoginResponse`](../../../_turnkey/sdk-types/TStampLoginResponse/readme)\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:977 - -Refreshes the session associated with the specified session key, or the active session by default. - -- This function refreshes the session and updates the session token and key pair associated with the given session key. -- If a sessionKey is provided, it will refresh the session under that key; otherwise, it will use the current active session key. -- Optionally allows specifying a new expiration time for the session, a custom public key, and whether to invalidate the existing session after refreshing. -- Makes a request to the Turnkey API to stamp a new login and stores the refreshed session token. -- Automatically manages key pair cleanup and session storage to ensure consistency. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### expirationSeconds? - -`string` - -expiration time in seconds for the refreshed session (defaults to the configured default). - -###### invalidateExisitng? - -`boolean` - -flag to invalidate the existing session before refreshing (defaults to false). - -###### publicKey? - -`string` - -public key to use for the refreshed session (if not provided, a new key pair will be generated). - -###### sessionKey? - -`string` - -session key to refresh the session under (defaults to the active session key). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper. - -#### Returns - -`Promise`\<`undefined` \| [`TStampLoginResponse`](../../../_turnkey/sdk-types/TStampLoginResponse/readme)\> - -A promise that resolves to a `TStampLoginResponse` object containing the refreshed session details. - -#### Throws - -If the session key does not exist, if there is no active session, or if there is an error refreshing the session. - -#### Inherited from - -`TurnkeyClientMethods.refreshSession` - -*** - -### removeOauthProviders() - -> **removeOauthProviders**: (`params`) => `Promise`\<`string`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:679 - -Removes a list of OAuth providers from the user. - -- This function removes OAuth providers (e.g., Google, Apple) from the user's account. -- If a userId is provided, it removes the providers for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Returns an array of remaining provider IDs associated with the user after removal. - -#### Parameters - -##### params - -###### providerIds - -`string`[] - -IDs of the OAuth providers to remove. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove the provider for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of provider IDs that were removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the OAuth provider. - -#### Inherited from - -`TurnkeyClientMethods.removeOauthProviders` - -*** - -### removePasskeys() - -> **removePasskeys**: (`params`) => `Promise`\<`string`[]\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:721 - -Removes passkeys (authenticator) from the user. - -- This function removes passkeys (WebAuthn/FIDO2 authenticators) from the user's account. -- If a userId is provided, it removes the passkeys for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Returns an array of remaining authenticator IDs for the user after removal. - -#### Parameters - -##### params - -###### authenticatorIds - -`string`[] - -IDs of the authenticators (passkeys) to remove. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove the passkeys for a specific user (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of authenticator IDs that were removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the passkeys. - -#### Inherited from - -`TurnkeyClientMethods.removePasskeys` - -*** - -### removeUserEmail() - -> **removeUserEmail**: (`params?`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:578 - -Removes the user's email address. - -- This function removes the user's email address by setting it to an empty string. -- If a userId is provided, it removes the email for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove a specific user's email address (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user whose email was removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the user email. - -#### Inherited from - -`TurnkeyClientMethods.removeUserEmail` - -*** - -### removeUserPhoneNumber() - -> **removeUserPhoneNumber**: (`params?`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:617 - -Removes the user's phone number. - -- This function removes the user's phone number by setting it to an empty string. -- If a userId is provided, it removes the phone number for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to remove a specific user's phone number (defaults to the current session's userId). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user whose phone number was removed. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error removing the user phone number. - -#### Inherited from - -`TurnkeyClientMethods.removeUserPhoneNumber` - -*** - -### session - -> **session**: `undefined` \| [`Session`](../../../sdk-browser/index/Session/readme) - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:42](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L42) - -*** - -### setActiveSession() - -> **setActiveSession**: (`params`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:1022 - -Sets the active session to the specified session key. - -- This function updates the `activeSessionKey` in persistent storage to the specified session key. -- Ensures that subsequent operations use the session associated with this key as the active session. -- Does not validate whether the session key exists or is valid; it simply updates the pointer. -- Useful for switching between multiple stored sessions or restoring a previous session context. - -#### Parameters - -##### params - -###### sessionKey - -`string` - -session key to set as the active session. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the active session key is successfully set. - -#### Throws - -If the client is not initialized or if there is an error setting the active session key. - -#### Inherited from - -`TurnkeyClientMethods.setActiveSession` - -*** - -### signAndSendTransaction() - -> **signAndSendTransaction**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:516 - -Signs and broadcasts a transaction using the specified wallet account. - -- For **connected wallets**: - - Calls the wallet’s native `signAndSendTransaction` method. - - Does **not** require an `rpcUrl`. - -- For **embedded wallets**: - - Signs the transaction using the Turnkey API. - - Requires an `rpcUrl` to broadcast the transaction. - - Broadcasts the transaction using a JSON-RPC client. - -#### Parameters - -##### params - -###### rpcUrl? - -`string` - -required for embedded wallets to broadcast the signed transaction. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -optional stamper to tag the signing request. - -###### transactionType - -[`v1TransactionType`](../../../_turnkey/sdk-types/v1TransactionType/readme) - -transaction type (e.g., "TRANSACTION_TYPE_SOLANA"). - -###### unsignedTransaction - -`string` - -unsigned transaction (serialized string). - -###### walletAccount - -`WalletAccount` - -wallet account to use for signing and sending. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a transaction signature or hash. - -#### Throws - -If signing or broadcasting fails. - -#### Inherited from - -`TurnkeyClientMethods.signAndSendTransaction` - -*** - -### signMessage() - -> **signMessage**: (`params`) => `Promise`\<[`v1SignRawPayloadResult`](../../../_turnkey/sdk-types/v1SignRawPayloadResult/readme)\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:466 - -Signs a message using the specified wallet account. - -- Supports both embedded and connected wallets. -- For **connected wallets**: - - Delegates signing to the wallet provider’s native signing method. - - **Important:** For Ethereum wallets (e.g., MetaMask), signatures follow [EIP-191](https://eips.ethereum.org/EIPS/eip-191). - The message is automatically prefixed with `"\x19Ethereum Signed Message:\n" + message length` - before signing. As a result, this signature **cannot be used as a raw transaction signature** - or broadcast on-chain. -- For **embedded wallets**, uses the Turnkey API to sign the message directly. -- Automatically handles message encoding and hashing based on the wallet account’s address format, - unless explicitly overridden. - -#### Parameters - -##### params - -###### addEthereumPrefix? - -`boolean` - -whether to prefix the message with Ethereum's `"\x19Ethereum Signed Message:\n"` string. - - If `true` (default for Ethereum), the message is prefixed before signing. - - If `false`: - - Connected wallets will throw an error because they always prefix automatically. - - Embedded wallets will sign the raw message without any prefix. - -###### encoding? - -[`v1PayloadEncoding`](../../../_turnkey/sdk-types/v1PayloadEncoding/readme) - -override for the payload encoding (defaults to the encoding appropriate for the address type). - -###### hashFunction? - -[`v1HashFunction`](../../../_turnkey/sdk-types/v1HashFunction/readme) - -override for the hash function (defaults to the hash function appropriate for the address type). - -###### message - -`string` - -message to sign. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -stamper to tag the signing request (e.g., Passkey, ApiKey, or Wallet). - -###### walletAccount - -`WalletAccount` - -wallet account to use for signing. - -#### Returns - -`Promise`\<[`v1SignRawPayloadResult`](../../../_turnkey/sdk-types/v1SignRawPayloadResult/readme)\> - -A promise resolving to a `v1SignRawPayloadResult` containing the signature and metadata. - -#### Throws - -If signing fails, if the wallet account does not support signing, or if the response is invalid. - -#### Inherited from - -`TurnkeyClientMethods.signMessage` - -*** - -### signTransaction() - -> **signTransaction**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:490 - -Signs a transaction using the specified wallet account. - -- This function signs a blockchain transaction using the provided wallet address and transaction data. -- Supports all Turnkey-supported blockchain networks (e.g., Ethereum, Solana, Tron). -- Automatically determines the appropriate signing method based on the transaction type. -- Delegates signing to the Turnkey API, which returns the signed transaction and related metadata. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Parameters - -##### params - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### transactionType - -[`v1TransactionType`](../../../_turnkey/sdk-types/v1TransactionType/readme) - -type of transaction (e.g., "TRANSACTION_TYPE_ETHEREUM", "TRANSACTION_TYPE_SOLANA", "TRANSACTION_TYPE_TRON"). - -###### unsignedTransaction - -`string` - -unsigned transaction data (serialized as a string) to be signed. - -###### walletAccount - -`WalletAccount` - -wallet account to use for signing the transaction. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a `TSignTransactionResponse` object containing the signed transaction and any additional signing metadata. - -#### Throws - -If there is an error signing the transaction or if the response is invalid. - -#### Inherited from - -`TurnkeyClientMethods.signTransaction` - -*** - -### signUpWithOauth() - -> **signUpWithOauth**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:393 - -Signs up a user using OAuth authentication. - -- This function creates a new sub-organization for the user using the provided OIDC token, public key, and provider name. -- Handles the full OAuth sign-up flow, including sub-organization creation and session management. -- Optionally accepts additional sub-organization creation parameters and a custom session key. -- After successful sign-up, automatically logs in the user and returns a signed JWT session token. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../CreateSubOrgParams/readme) - -parameters for sub-organization creation (e.g., authenticators, user metadata). - -###### oidcToken - -`string` - -OIDC token received after successful authentication with the OAuth provider. - -###### providerName - -`string` - -name of the OAuth provider (e.g., "Google", "Apple"). - -###### publicKey - -`string` - -public key to associate with the new sub-organization. - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during the OAuth sign-up or login process. - -#### Inherited from - -`TurnkeyClientMethods.signUpWithOauth` - -*** - -### signUpWithOtp() - -> **signUpWithOtp**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:292 - -Signs up a user using an OTP verification token. - -- This function signs up a user using the verification token received after OTP verification (from email or SMS). -- Creates a new sub-organization for the user with the provided parameters and associates the contact (email or phone) with the sub-organization. -- Automatically generates a new API key pair for authentication and session management. -- Stores the resulting session token under the specified session key, or the default session key if not provided. -- Handles both email and SMS OTP types, and supports additional sub-organization creation parameters. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../CreateSubOrgParams/readme) - -parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### invalidateExisting? - -`boolean` - -flag to invalidate existing session for the user. - -###### otpType - -[`OtpType`](../OtpType/readme) - -type of OTP being used (OtpType.Email or OtpType.Sms). - -###### sessionKey? - -`string` - -session key to use for session creation (defaults to the default session key). - -###### verificationToken - -`string` - -verification token received after OTP verification. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during the OTP sign-up process or session storage. - -#### Inherited from - -`TurnkeyClientMethods.signUpWithOtp` - -*** - -### signUpWithPasskey() - -> **signUpWithPasskey**: (`params?`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:93 - -Signs up a user using a passkey, creating a new sub-organization and session. - -- This function creates a new passkey authenticator and uses it to register a new sub-organization for the user. -- Handles both passkey creation and sub-organization creation in a single flow. -- Optionally accepts additional sub-organization parameters, a custom session key, a custom passkey display name, and a custom session expiration. -- Automatically generates a new API key pair for authentication and session management. -- Stores the resulting session token and manages cleanup of unused key pairs. - -#### Parameters - -##### params? - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../CreateSubOrgParams/readme) - -parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### passkeyDisplayName? - -`string` - -display name for the passkey (defaults to a generated name based on the current timestamp). - -###### sessionKey? - -`string` - -session key to use for storing the session (defaults to the default session key). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during passkey creation, sub-organization creation, or session storage. - -#### Inherited from - -`TurnkeyClientMethods.signUpWithPasskey` - -*** - -### signUpWithWallet() - -> **signUpWithWallet**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:181 - -Signs up a user using a wallet, creating a new sub-organization and session. - -- This function creates a new wallet authenticator and uses it to register a new sub-organization for the user. -- Handles both wallet authentication and sub-organization creation in a single flow. -- Optionally accepts additional sub-organization parameters, a custom session key, and a custom session expiration. -- Automatically generates additional API key pairs for authentication and session management. -- Stores the resulting session token under the specified session key, or the default session key if not provided, and manages cleanup of unused key pairs. - -#### Parameters - -##### params - -###### createSubOrgParams? - -[`CreateSubOrgParams`](../CreateSubOrgParams/readme) - -parameters for creating a sub-organization (e.g., authenticators, user metadata). - -###### expirationSeconds? - -`string` - -session expiration time in seconds (defaults to the configured default). - -###### sessionKey? - -`string` - -session key to use for storing the session (defaults to the default session key). - -###### walletProvider - -`WalletProvider` - -wallet provider to use for authentication. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to a signed JWT session token for the new sub-organization. - -#### Throws - -If there is an error during wallet authentication, sub-organization creation, session storage, or cleanup. - -#### Inherited from - -`TurnkeyClientMethods.signUpWithWallet` - -*** - -### storeSession() - -> **storeSession**: (`params`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:928 - -Stores a session token and updates the session associated with the specified session key, or by default the active session. - -- This function parses and stores a signed JWT session token in local storage, associating it with the given session key. -- If a sessionKey is provided, the session will be stored under that key; otherwise, it will use the default session key. -- If a session already exists for the session key, its associated key pair will be deleted before storing the new session. -- After storing the session, any unused key pairs are automatically cleared from storage. -- Ensures that session management is consistent and prevents orphaned key pairs. - -#### Parameters - -##### params - -###### sessionKey? - -`string` - -session key to store the session under (defaults to the default session key). - -###### sessionToken - -`string` - -JWT session token to store. - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the session is successfully stored. - -#### Throws - -If there is an error storing the session or cleaning up key pairs. - -#### Inherited from - -`TurnkeyClientMethods.storeSession` - -*** - -### switchWalletProviderChain() - -> **switchWalletProviderChain**: (`walletProvider`, `chainOrId`) => `Promise`\<`void`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:142 - -Switches the specified wallet provider to a different blockchain chain. - -- Requires the wallet manager and its connector to be initialized. -- The wallet provider must have at least one connected address. -- Does nothing if the wallet provider is already on the desired chain. - -#### Parameters - -##### walletProvider - -`WalletProvider` - -wallet provider to switch. - -##### chainOrId - -target chain as a chain ID string or SwitchableChain object. - -`string` | `SwitchableChain` - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves once the chain switch is complete. - -#### Throws - -If the wallet manager is uninitialized, the provider is not connected, or the switch fails. - -#### Inherited from - -`TurnkeyClientMethods.switchWalletProviderChain` - -*** - -### updateUserEmail() - -> **updateUserEmail**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:559 - -Updates the user's email address. - -- This function updates the user's email address and, if provided, verifies it using a verification token (typically from an OTP flow). -- If a userId is provided, it updates the email for that specific user; otherwise, it uses the current session's userId. -- If a verificationToken is not provided, the email will be updated but will not be marked as verified. -- Automatically ensures an active session exists before making the request. -- Handles session management and error reporting for both update and verification flows. - -#### Parameters - -##### params - -###### email - -`string` - -new email address to set for the user. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to update a specific user's email (defaults to the current session's userId). - -###### verificationToken? - -`string` - -verification token from OTP email verification (required if verifying the email). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the updated user. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error updating or verifying the user email. - -#### Inherited from - -`TurnkeyClientMethods.updateUserEmail` - -*** - -### updateUserName() - -> **updateUserName**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:636 - -Updates the user's name. - -- This function updates the user's display name. -- If a userId is provided, it updates the name for that specific user; otherwise, it uses the current session's userId. -- Automatically ensures an active session exists before making the request. -- Optionally allows stamping the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). -- Handles session management and error reporting for the update flow. - -#### Parameters - -##### params - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to update a specific user's name (defaults to the current session's userId). - -###### userName - -`string` - -new name to set for the user. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the updated user. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error updating the user name. - -#### Inherited from - -`TurnkeyClientMethods.updateUserName` - -*** - -### updateUserPhoneNumber() - -> **updateUserPhoneNumber**: (`params`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:598 - -Updates the user's phone number. - -- This function updates the user's phone number and, if provided, verifies it using a verification token (from an OTP flow). -- If a userId is provided, it updates the phone number for that specific user; otherwise, it uses the current session's userId. -- If a verificationToken is not provided, the phone number will be updated but will not be marked as verified. -- Automatically ensures an active session exists before making the request. -- Handles session management and error reporting for both update and verification flows. - -#### Parameters - -##### params - -###### phoneNumber - -`string` - -new phone number to set for the user. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### userId? - -`string` - -user ID to update a specific user's phone number (defaults to the current session's userId). - -###### verificationToken? - -`string` - -verification token from OTP phone verification (required if verifying the phone number). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the updated user. - -#### Throws - -If there is no active session, if the userId is missing, or if there is an error updating or verifying the user phone number. - -#### Inherited from - -`TurnkeyClientMethods.updateUserPhoneNumber` - -*** - -### user - -> **user**: `undefined` \| [`v1User`](../../../_turnkey/sdk-types/v1User/readme) - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:47](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L47) - -*** - -### verifyOtp() - -> **verifyOtp**: (`params`) => `Promise`\<\{ `subOrganizationId`: `string`; `verificationToken`: `string`; \}\> - -Defined in: core/dist/\_\_clients\_\_/core.d.ts:243 - -Verifies the OTP code sent to the user. - -- This function verifies the OTP code entered by the user against the OTP sent to their contact information (email or phone) using the auth proxy. -- If verification is successful, it returns the sub-organization ID associated with the contact (if it exists) and a verification token. -- The verification token can be used for subsequent login or sign-up flows. -- Handles both email and SMS OTP types. - -#### Parameters - -##### params - -###### contact - -`string` - -contact information for the user (e.g., email address or phone number). - -###### otpCode - -`string` - -OTP code entered by the user. - -###### otpId - -`string` - -ID of the OTP to verify (returned from `initOtp`). - -###### otpType - -[`OtpType`](../OtpType/readme) - -type of OTP being verified (OtpType.Email or OtpType.Sms). - -#### Returns - -`Promise`\<\{ `subOrganizationId`: `string`; `verificationToken`: `string`; \}\> - -A promise that resolves to an object containing: - - subOrganizationId: sub-organization ID if the contact is already associated with a sub-organization, or an empty string if not. - - verificationToken: verification token to be used for login or sign-up. - -#### Throws - -If there is an error during the OTP verification process, such as an invalid code or network failure. - -#### Inherited from - -`TurnkeyClientMethods.verifyOtp` - -*** - -### wallets - -> **wallets**: `Wallet`[] - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:48](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L48) - -## Methods - -### handleAddOauthProvider() - -> **handleAddOauthProvider**(`params`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:451](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L451) - -Handles the addition of an OAuth provider for the user. - -- This function opens a modal-driven flow for linking a new OAuth provider (Google, Apple, or Facebook) to the user's account. -- It supports all enabled OAuth providers as defined in the configuration and dynamically triggers the appropriate OAuth flow. -- Uses the handleGoogleOauth, handleAppleOauth, and handleFacebookOauth functions to initiate the provider-specific OAuth authentication process. -- After successful authentication, the provider is linked to the user's account and a success page is shown. -- Automatically refreshes the user details state after linking to ensure the latest provider list is available in the provider. -- Optionally allows specifying the stamper to use for the addition (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control. -- Handles all error cases and throws a TurnkeyError with appropriate error codes. - -#### Parameters - -##### params - -###### providerName - -[`OAuthProviders`](../../../_turnkey/sdk-types/OAuthProviders/readme) - -The name of the OAuth provider to add (OAuthProviders.GOOGLE, OAuthProviders.APPLE, OAuthProviders.FACEBOOK). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to specify the stamper to use for the addition (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Returns - -`Promise`\<`void`\> - -A void promise. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error adding the provider. - -*** - -### handleAddPasskey() - -> **handleAddPasskey**(`params?`): `Promise`\<`string`[]\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:504](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L504) - -Handles the addition of a passkey (authenticator) for the user. - -- This function opens a modal-driven flow for adding a new passkey authenticator (WebAuthn/FIDO2) to the user's account. -- If a `name` or `displayName` is provided, those will be used for the passkey metadata; otherwise, defaults are generated based on the website and timestamp. -- The passkey is created and linked to the specified user (by `userId`) or the current session's user if not provided. -- After successful addition, a success page is shown for the specified duration (or skipped if `successPageDuration` is 0). -- Supports stamping the request with a specific stamper (`StamperType.Passkey`, `StamperType.ApiKey`, or `StamperType.Wallet`) for granular authentication control. -- Automatically refreshes the user details state after successful addition to ensure the latest authenticators list is available in the provider. -- Handles all error cases and throws a `TurnkeyError` with appropriate error codes. - -#### Parameters - -##### params? - -###### displayName? - -`string` - -display name for the passkey (shown to the user in the UI). - -###### name? - -`string` - -internal name for the passkey (for backend or developer reference). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (`StamperType.Passkey`, `StamperType.ApiKey`, or `StamperType.Wallet`). - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after addition (default: 0, no success page). - -###### userId? - -`string` - -user ID to add the passkey for a specific user (defaults to current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to the user's updated passkeys. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error adding the passkey. - -*** - -### handleAddPhoneNumber() - -> **handleAddPhoneNumber**(`params?`): `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:426](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L426) - -Handles the add phone number flow. - -- This function opens a modal with the UpdatePhoneNumber component for adding and verifying the user's phone number. -- If a phone number is provided, it will immediately send an OTP request to the user and display the OTP verification modal. -- Supports both manual entry and pre-filled phone numbers, as well as custom modal titles and subtitles. -- Uses the addPhoneNumberContinue helper to manage the OTP flow, verification, and update logic. -- After successful verification and update, the user details state is refreshed and an optional success page can be shown. -- Supports customizing the duration of the success page after update. -- Handles all error cases and throws a TurnkeyError with appropriate error codes. - -#### Parameters - -##### params? - -###### formattedPhone? - -`string` - -parameter to specify the formatted phone number. - -###### phoneNumber? - -`string` - -parameter to specify the new phone number. - -###### subTitle? - -`string` - -subtitle for the modal. - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after update (default: 0, no success page). - -###### title? - -`string` - -title for the modal. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user that was changed. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error adding the phone number. - -*** - -### handleAppleOauth() - -> **handleAppleOauth**(`params?`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:159](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L159) - -Handles the Apple OAuth flow. - -- This function initiates the Apple OAuth flow by either redirecting the user to the Apple authorization page or opening it in a popup window. -- The flow type is determined by the `openInPage` parameter: if true, the current page is redirected; if false (default), a popup window is used. -- Generates a new ephemeral API key pair and uses its public key as the nonce for the OAuth request, ensuring cryptographic binding of the session. -- Constructs the Apple OAuth URL with all required parameters, including client ID, redirect URI, response type, response mode, nonce, and state. -- The `state` parameter includes the provider, flow type, public key, and any additional state parameters for tracking or custom logic. -- If `openInPage` is true, the function redirects and returns a promise that resolves on redirect or times out after 5 minutes. -- If `openInPage` is false, a popup window is opened and the function returns a promise that resolves when the flow completes, or rejects if the window is closed or times out. -- On successful authentication, the function either calls the provided `onOauthSuccess` callback, triggers the `onOauthRedirect` callback from provider callbacks, or completes the OAuth flow internally by calling `completeOauth`. -- Handles all error cases, including missing configuration, popup failures, and timeouts, and throws a `TurnkeyError` with appropriate error codes. - -#### Parameters - -##### params? - -###### additionalState? - -`Record`\<`string`, `string`\> - -Additional key-value pairs to include in the OAuth state parameter for custom tracking or logic. - -###### clientId? - -`string` - -The Apple Client ID to use (defaults to the client ID from configuration). - -###### onOauthSuccess? - -(`params`) => `any` - -Callback function to handle the successful OAuth response (receives `{ oidcToken, providerName }`). - -onOauthSuccess params: -- oidcToken: The OIDC token received from the OAuth flow. -- providerName: The name of the OAuth provider ("apple"). - -###### openInPage? - -`boolean` - -Whether to open the OAuth flow in the current page (redirect) or a popup window (default: false). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the OAuth flow is successfully initiated and completed, or rejects on error or timeout. - -#### Throws - -If the configuration is not ready, required parameters are missing, or if there is an error initiating or completing the OAuth flow. - -*** - -### handleExportPrivateKey() - -> **handleExportPrivateKey**(`params`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:246](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L246) - -handles the export private key flow. - -- This function opens a modal with the ExportComponent for exporting a private key. -- Uses Turnkey's export iframe flow to securely export private key material. -- The export process encrypts the exported bundle to a target public key, which is generated and managed inside the iframe for maximum security. -- A request is made to the Turnkey API to export the private key, encrypted to the target public key. -- The resulting export bundle is injected into the iframe, where it is decrypted and displayed to the user. -- If a custom iframe URL is used, a target public key can be provided explicitly. -- Optionally allows specifying the stamper to use for the export (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control. -- The modal-driven UI ensures the user is guided through the export process and can securely retrieve their exported material. - -#### Parameters - -##### params - -###### privateKeyId - -`string` - -The ID of the private key to export. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -The stamper to use for the export (Passkey, ApiKey, or Wallet). - -###### targetPublicKey? - -`string` - -The target public key to encrypt the export bundle to (required for custom iframe flows). - -#### Returns - -`Promise`\<`void`\> - -A void promise. - -*** - -### handleExportWallet() - -> **handleExportWallet**(`params`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:223](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L223) - -Handles the export wallet flow. - -- This function opens a modal with the ExportComponent for exporting a wallet. -- Uses Turnkey's export iframe flow to securely export wallet material. -- The export process encrypts the exported bundle to a target public key, which is generated and managed inside the iframe for maximum security. -- A request is made to the Turnkey API to export the wallet, encrypted to the target public key. -- The resulting export bundle is injected into the iframe, where it is decrypted and displayed to the user. -- If a custom iframe URL is used, a target public key can be provided explicitly. -- Optionally allows specifying the stamper to use for the export (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control. -- The modal-driven UI ensures the user is guided through the export process and can securely retrieve their exported material. - -#### Parameters - -##### params - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -The stamper to use for the export (Passkey, ApiKey, or Wallet). - -###### targetPublicKey? - -`string` - -The target public key to encrypt the export bundle to (required for custom iframe flows). - -###### walletId - -`string` - -The ID of the wallet to export. - -#### Returns - -`Promise`\<`void`\> - -A void promise. - -*** - -### handleExportWalletAccount() - -> **handleExportWalletAccount**(`params`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:271](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L271) - -Handles the export wallet account flow. - -- This function opens a modal with the ExportComponent for exporting a wallet account. -- Uses Turnkey's export iframe flow to securely export wallet account material. -- The export process encrypts the exported bundle to a target public key, which is generated and managed inside the iframe for maximum security. -- A request is made to the Turnkey API to export the wallet account, encrypted to the target public key. -- The resulting export bundle is injected into the iframe, where it is decrypted and displayed to the user. -- If a custom iframe URL is used, a target public key can be provided explicitly. -- Optionally allows specifying the stamper to use for the export (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control. -- The modal-driven UI ensures the user is guided through the export process and can securely retrieve their exported material. - -#### Parameters - -##### params - -###### address - -`string` - -The address of the wallet account to export. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -The stamper to use for the export (Passkey, ApiKey, or Wallet). - -###### targetPublicKey? - -`string` - -The target public key to encrypt the export bundle to (required for custom iframe flows). - -#### Returns - -`Promise`\<`void`\> - -A void promise. - -*** - -### handleFacebookOauth() - -> **handleFacebookOauth**(`params?`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:195](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L195) - -Handles the Facebook OAuth flow. - -- This function initiates the Facebook OAuth flow by either redirecting the user to the Facebook authorization page or opening it in a popup window. -- The flow type is determined by the `openInPage` parameter: if true, the current page is redirected; if false (default), a popup window is used. -- Generates a new ephemeral API key pair and uses its public key as the nonce for the OAuth request, ensuring cryptographic binding of the session. -- Uses PKCE (Proof Key for Code Exchange) for enhanced security, generating a code verifier and challenge for the Facebook OAuth flow. -- Constructs the Facebook OAuth URL with all required parameters, including client ID, redirect URI, response type, code challenge, nonce, and state. -- The `state` parameter includes the provider, flow type, public key, and any additional state parameters for tracking or custom logic. -- If `openInPage` is true, the function redirects and returns a promise that resolves on redirect or times out after 5 minutes. -- If `openInPage` is false, a popup window is opened and the function returns a promise that resolves when the flow completes, or rejects if the window is closed or times out. -- On successful authentication, the function either calls the provided `onOauthSuccess` callback, triggers the `onOauthRedirect` callback from provider callbacks, or completes the OAuth flow internally by calling `completeOauth`. -- Handles all error cases, including missing configuration, popup failures, and timeouts, and throws a `TurnkeyError` with appropriate error codes. - -#### Parameters - -##### params? - -###### additionalState? - -`Record`\<`string`, `string`\> - -Additional key-value pairs to include in the OAuth state parameter for custom tracking or logic. - -###### clientId? - -`string` - -The Facebook Client ID to use (defaults to the client ID from configuration). - -###### onOauthSuccess? - -(`params`) => `any` - -Callback function to handle the successful OAuth response (receives `{ oidcToken, providerName }`). - -onOauthSuccess params: -- oidcToken: The OIDC token received from the OAuth flow. -- providerName: The name of the OAuth provider ("facebook"). - -###### openInPage? - -`boolean` - -Whether to open the OAuth flow in the current page (redirect) or a popup window (default: false). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the OAuth flow is successfully initiated and completed, or rejects on error or timeout. - -#### Throws - -If the configuration is not ready, required parameters are missing, or if there is an error initiating or completing the OAuth flow. - -*** - -### handleGoogleOauth() - -> **handleGoogleOauth**(`params?`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:124](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L124) - -Handles the Google OAuth flow. - -- This function initiates the Google OAuth flow by redirecting the user to the Google authorization page or opening it in a popup window. -- It supports both "popup" and "redirect" flows, determined by the `openInPage` parameter. -- Generates a new ephemeral API key pair and uses its public key as the nonce for the OAuth request, ensuring cryptographic binding of the session. -- Constructs the Google OAuth URL with all required parameters, including client ID, redirect URI, response type, scope, nonce, and state. -- The `state` parameter includes the provider, flow type, public key, and any additional state parameters for tracking or custom logic. -- If `openInPage` is true, the current page is redirected to the Google OAuth URL and the function returns a promise that resolves on redirect or times out after 5 minutes. -- If `openInPage` is false, a popup window is opened for the OAuth flow, and the function returns a promise that resolves when the flow completes or rejects if the window is closed or times out. -- On successful authentication, the function either calls the provided `onOauthSuccess` callback, triggers the `onOauthRedirect` callback from provider callbacks, or completes the OAuth flow internally by calling `completeOauth`. -- Handles all error cases, including missing configuration, popup failures, and timeouts, and throws a `TurnkeyError` with appropriate error codes. - -#### Parameters - -##### params? - -###### additionalState? - -`Record`\<`string`, `string`\> - -Additional key-value pairs to include in the OAuth state parameter for custom tracking or logic. - -###### clientId? - -`string` - -The Google Client ID to use (defaults to the client ID from configuration). - -###### onOauthSuccess? - -(`params`) => `any` - -Callback function to handle the successful OAuth response (receives `{ oidcToken, providerName }`). - -onOauthSuccess params: -- oidcToken: The OIDC token received from the OAuth flow. -- providerName: The name of the OAuth provider ("google"). - -###### openInPage? - -`boolean` - -Whether to open the OAuth flow in the current page (redirect) or a popup window (default: false). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the OAuth flow is successfully initiated and completed, or rejects on error or timeout. - -#### Throws - -If the configuration is not ready, required parameters are missing, or if there is an error initiating or completing the OAuth flow. - -*** - -### handleImportWallet() - -> **handleImportWallet**(`params?`): `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:293](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L293) - -Handles the import flow. - -- This function opens a modal with the ImportComponent for importing a wallet. -- Supports importing wallets using an encrypted bundle, with optional default accounts or custom account parameters. -- Allows users to specify default wallet accounts (address formats or account params) to pre-fill the import form. -- Supports customizing the duration of the success page shown after a successful import. -- Allows specifying the stamper to use for the import (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control. -- Ensures the imported wallet is added to the user's wallet list and the provider state is refreshed. - -#### Parameters - -##### params? - -###### defaultWalletAccounts? - -[`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme)[] \| [`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] - -array of default wallet accounts (v1AddressFormat[] or v1WalletAccountParams[]) to pre-fill the import form. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to specify the stamper to use for the import (Passkey, ApiKey, or Wallet). - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after import (default: 0, no success page). - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the new wallet's ID. - -*** - -### handleLinkExternalWallet() - -> **handleLinkExternalWallet**(`params?`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:587](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L587) - -Handles the linking of an external wallet account to the user's Turnkey account. - -- This function opens a modal with the LinkWalletModal component, allowing the user to select and connect an external wallet provider (such as MetaMask, Phantom, etc.). -- It fetches the list of available wallet providers (for all supported chains) and passes them to the modal for user selection. -- After a successful wallet connection, the provider state is refreshed to include the newly linked wallet account. -- Optionally, a success page is shown for the specified duration after linking (default: 2000ms). -- Supports both Ethereum and Solana wallet providers, and can be extended to additional chains as supported by Turnkey. -- Handles all error cases and throws a TurnkeyError with appropriate error codes if the client is not initialized or no active session is found. - -#### Parameters - -##### params? - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after linking (default: 2000ms). - -#### Returns - -`Promise`\<`void`\> - -A void promise. - -#### Throws - -If the client is not initialized or if no active session is found. - -*** - -### handleLogin() - -> **handleLogin**(): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:97](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L97) - -Handles the login or sign-up flow. - -- This function opens a modal with the AuthComponent, allowing the user to log in or sign up using any enabled authentication method (Passkey, Wallet, OTP, or OAuth). -- It automatically determines available authentication methods based on the current provider configuration and proxy settings. -- The modal-driven flow guides the user through the appropriate authentication steps, including social login if enabled. -- After successful authentication, the provider state is updated and all relevant session, user, and wallet data are refreshed. -- This function is typically used to trigger authentication from a UI button or navigation event. - -#### Returns - -`Promise`\<`void`\> - -A void promise. - -*** - -### handleRemoveOauthProvider() - -> **handleRemoveOauthProvider**(`params`): `Promise`\<`string`[]\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:476](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L476) - -Handles the removal of an OAuth provider. - -- This function opens a modal with the RemoveOAuthProvider component, allowing the user to confirm and remove an OAuth provider (such as Google, Apple, or Facebook) from their account. -- It supports specifying the provider ID to remove, as well as optional modal title and subtitle for custom UI messaging. -- After successful removal, the user details state is refreshed to reflect the updated list of linked OAuth providers. -- Optionally, a callback can be provided to handle successful removal, receiving the updated list of provider IDs. -- Supports customizing the duration of the success page shown after removal. -- Allows specifying the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control. -- Handles all error cases and throws a TurnkeyError with appropriate error codes. - -#### Parameters - -##### params - -###### providerId - -`string` - -The ID of the OAuth provider to remove (as found in the user's provider list). - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### subTitle? - -`string` - -subtitle for the modal. - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after removal (default: 0, no success page). - -###### title? - -`string` - -title for the modal. - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of provider IDs that were removed. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error removing the provider. - -*** - -### handleRemovePasskey() - -> **handleRemovePasskey**(`params`): `Promise`\<`string`[]\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:532](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L532) - -Handles the removal of a passkey (authenticator) for the user. - -- This function opens a modal with the RemovePasskey component, allowing the user to confirm and remove a passkey authenticator from their account. -- It supports specifying the authenticator ID to remove, as well as optional modal title and subtitle for custom UI messaging. -- After successful removal, the user details state is refreshed to reflect the updated list of authenticators. -- Supports customizing the duration of the success page shown after removal. -- Allows specifying the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet) for granular authentication control. -- Handles all error cases and throws a TurnkeyError with appropriate error codes. - -#### Parameters - -##### params - -###### authenticatorId - -`string` - -The ID of the authenticator (passkey) to remove. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### subTitle? - -`string` - -subtitle for the modal. - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after removal (default: 0, no success page). - -###### title? - -`string` - -title for the modal. - -###### userId? - -`string` - -user ID to remove the passkey for a specific user (defaults to current session's userId). - -#### Returns - -`Promise`\<`string`[]\> - -A promise that resolves to an array of authenticator IDs that were removed. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error removing the passkey. - -*** - -### handleRemoveUserEmail() - -> **handleRemoveUserEmail**(`params?`): `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:600](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L600) - -Handles the removal of a user's email address from their Turnkey account. - -- This function opens a modal with the RemoveUserEmail component, allowing the user to confirm and remove their email address. - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after removal (default: 0, no success page). - -###### userId? - -`string` - -The user ID to remove the email for (defaults to current session's userId). - -#### Returns - -`Promise`\<`string`\> - -*** - -### handleRemoveUserPhoneNumber() - -> **handleRemoveUserPhoneNumber**(`params?`): `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:615](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L615) - -Handles the removal of a user's phone number from their Turnkey account. - -- This function opens a modal with the RemoveUserPhoneNumber component, allowing the user to confirm and remove their phone number. - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to specify the stamper to use for the removal (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after removal (default: 0, no success page). - -###### userId? - -`string` - -The user ID to remove the phone number for (defaults to current session's userId). - -#### Returns - -`Promise`\<`string`\> - -*** - -### handleSignMessage() - -> **handleSignMessage**(`params`): `Promise`\<[`v1SignRawPayloadResult`](../../../_turnkey/sdk-types/v1SignRawPayloadResult/readme)\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:561](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L561) - -Handles the signing of a message by displaying a modal for user interaction. - -- This function opens a modal with the SignMessageModal component, prompting the user to review and approve the message signing request. -- Supports signing with any wallet account managed by Turnkey, including externally linked wallets. -- Allows for optional overrides of the encoding and hash function used for the payload, enabling advanced use cases or compatibility with specific blockchains. -- Optionally displays a subtext in the modal for additional context or instructions to the user. -- Returns a promise that resolves to a `v1SignRawPayloadResult` object containing the signed message, signature, and metadata. - -#### Parameters - -##### params - -###### addEthereumPrefix? - -`boolean` - -whether to add the Ethereum prefix to the message (default: false). - -###### encoding? - -[`v1PayloadEncoding`](../../../_turnkey/sdk-types/v1PayloadEncoding/readme) - -encoding for the payload (defaults to the proper encoding for the account type). - -###### hashFunction? - -[`v1HashFunction`](../../../_turnkey/sdk-types/v1HashFunction/readme) - -hash function to use (defaults to the appropriate function for the account type). - -###### message - -`string` - -The message to sign. - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -###### subText? - -`string` - -subtext to display in the modal. - -###### successPageDuration? - -`number` - -duration in seconds to display the success page after signing. - -###### walletAccount - -`WalletAccount` - -The wallet account to use for signing. - -#### Returns - -`Promise`\<[`v1SignRawPayloadResult`](../../../_turnkey/sdk-types/v1SignRawPayloadResult/readme)\> - -A promise that resolves to a `v1SignRawPayloadResult` object containing the signed message. - -#### Throws - -If the client is not initialized or if there is an error during the signing process. - -*** - -### handleUpdateUserEmail() - -> **handleUpdateUserEmail**(`params?`): `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:318](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L318) - -Handles the update user name flow. - -- This function opens a modal with the UpdateUserName component for updating and verifying the user's name. -- If a userName is provided, it will directly update the user name without showing the modal. -- Uses updateUserName under the hood to perform the update and automatically refreshes the user details state after a successful update. -- Optionally displays a success page after the update, with customizable duration. -- Supports passing a custom title and subtitle for the modal UI. -- Handles all error cases and throws a TurnkeyError with appropriate error codes. - -#### Parameters - -##### params? - -###### email? - -`string` - -###### subTitle? - -`string` - -subtitle for the modal. - -###### successPageDuration? - -`number` - -duration (in ms) for the success page after update (default: 0, no success page). - -###### title? - -`string` - -title for the modal. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user that was changed. - -#### Throws - -If the client is not initialized, no active session is found, or if there is an error updating the user name. - -*** - -### handleUpdateUserPhoneNumber() - -> **handleUpdateUserPhoneNumber**(`params?`): `Promise`\<`string`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:345](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L345) - -Handles the update user phone number flow. - -- This function opens a modal with the UpdatePhoneNumber component for updating and verifying the user's phone number. -- If a phoneNumber is provided, it will directly send an OTP request to the user and display the OTP verification modal. -- Supports both manual entry and pre-filled phone numbers, as well as custom modal titles and subtitles. -- Uses the updatePhoneNumberContinue helper to manage the OTP flow, verification, and update logic. -- After successful verification and update, the user details state is refreshed and an optional success page can be shown. -- Supports customizing the duration of the success page after update. -- Throws a TurnkeyError if the client is not initialized, no active session is found, SMS OTP is not enabled, or if there is an error updating the phone number. - -#### Parameters - -##### params? - -###### formattedPhone? - -`string` - -parameter to specify the formatted phone number. - -###### phoneNumber? - -`string` - -parameter to specify the new phone number. - -###### subTitle? - -`string` - -subtitle for the modal. - -###### successPageDuration? - -`number` - -duration for the success page (default: 0, no success page). - -###### title? - -`string` - -title for the modal. - -#### Returns - -`Promise`\<`string`\> - -A promise that resolves to the userId of the user that was changed. - -#### Throws - -If the client is not initialized, no active session is found, SMS OTP is not enabled, or if there is an error updating the phone number. - -*** - -### refreshUser() - -> **refreshUser**(`params?`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:64](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L64) - -Refreshes the user details. - -- This function fetches the latest user details for the current session (or optionally for a specific user/organization if provided) - and updates the `user` state variable in the provider. -- If a `stampWith` parameter is provided, it will use that stamper to fetch the user details (supports Passkey, ApiKey, or Wallet stampers). -- Automatically handles error reporting via the configured callbacks. -- Typically used after authentication, user profile updates, or linking/unlinking authenticators to ensure the provider state is up to date. -- If no user is found, the state will not be updated. - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the user details are successfully refreshed and state is updated. - -#### Throws - -If the client is not initialized or if there is an error refreshing the user details. - -*** - -### refreshWallets() - -> **refreshWallets**(`params?`): `Promise`\<`void`\> - -Defined in: [react-wallet-kit/src/providers/client/Types.tsx:82](https://github.com/tkhq/sdk/blob/main/packages/react-wallet-kit/src/providers/client/Types.tsx#L82) - -Refreshes the wallets state for the current user session. - -- This function fetches the latest list of wallets associated with the current session or user, - and updates the `wallets` state variable in the provider. -- If a `stampWith` parameter is provided, it will use that stamper to fetch the wallets - (supports Passkey, ApiKey, or Wallet stampers for granular authentication control). -- Automatically handles error reporting via the configured callbacks. -- Typically used after wallet creation, import, export, account changes, or authentication - to ensure the provider state is up to date. -- If no wallets are found, the state will be set to an empty array. - -#### Parameters - -##### params? - -###### stampWith? - -[`StamperType`](../StamperType/readme) - -parameter to stamp the request with a specific stamper (StamperType.Passkey, StamperType.ApiKey, or StamperType.Wallet). - -#### Returns - -`Promise`\<`void`\> - -A promise that resolves when the wallets are successfully refreshed and state is updated. - -#### Throws - -If the client is not initialized or if there is an error refreshing the wallets. diff --git a/generated-docs/sdks/react-wallet-kit/index/ConnectedWallet/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/ConnectedWallet/readme.mdx deleted file mode 100644 index 8a11595a2..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/ConnectedWallet/readme.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: "ConnectedWallet" -mode: wide ---- - -# Interface: ConnectedWallet - -Defined in: core/dist/\_\_types\_\_/base.d.ts:167 - -ConnectedWallet represents a connected wallet (Ex: MetaMask, Rabby, Phantom external wallets). - ConnectedWallet - -## Extends - -- [`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme) - -## Properties - -### accounts - -> **accounts**: `WalletAccount`[] - -Defined in: core/dist/\_\_types\_\_/base.d.ts:169 - -array of wallet accounts. - -*** - -### createdAt - -> **createdAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2729 - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`createdAt`](../../../_turnkey/sdk-types/v1Wallet/readme#createdat) - -*** - -### exported - -> **exported**: `boolean` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2732 - -True when a given Wallet is exported, false otherwise. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`exported`](../../../_turnkey/sdk-types/v1Wallet/readme#exported) - -*** - -### imported - -> **imported**: `boolean` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2734 - -True when a given Wallet is imported, false otherwise. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`imported`](../../../_turnkey/sdk-types/v1Wallet/readme#imported) - -*** - -### source - -> **source**: `Connected` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:168 - -source of the wallet, which is always "connected". - -*** - -### updatedAt - -> **updatedAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2730 - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`updatedAt`](../../../_turnkey/sdk-types/v1Wallet/readme#updatedat) - -*** - -### walletId - -> **walletId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2726 - -Unique identifier for a given Wallet. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`walletId`](../../../_turnkey/sdk-types/v1Wallet/readme#walletid) - -*** - -### walletName - -> **walletName**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2728 - -Human-readable name for a Wallet. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`walletName`](../../../_turnkey/sdk-types/v1Wallet/readme#walletname) diff --git a/generated-docs/sdks/react-wallet-kit/index/ConnectedWalletAccount/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/ConnectedWalletAccount/readme.mdx deleted file mode 100644 index 7ba17313e..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/ConnectedWalletAccount/readme.mdx +++ /dev/null @@ -1,235 +0,0 @@ ---- -title: "ConnectedWalletAccount" -mode: wide ---- - -# Interface: ConnectedWalletAccount - -Defined in: core/dist/\_\_types\_\_/base.d.ts:141 - -ConnectedWalletAccount represents a connected wallet account (Ex: MetaMask, Rabby, Phantom external wallets). - ConnectedWalletAccount - -## Extends - -- [`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme) - -## Properties - -### address - -> **address**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2752 - -Address generated using the Wallet seed and Account parameters. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`address`](../../../_turnkey/sdk-types/v1WalletAccount/readme#address) - -*** - -### addressFormat - -> **addressFormat**: [`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2750 - -Address format used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`addressFormat`](../../../_turnkey/sdk-types/v1WalletAccount/readme#addressformat) - -*** - -### createdAt - -> **createdAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2753 - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`createdAt`](../../../_turnkey/sdk-types/v1WalletAccount/readme#createdat) - -*** - -### curve - -> **curve**: [`v1Curve`](../../../_turnkey/sdk-types/v1Curve/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2744 - -Cryptographic curve used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`curve`](../../../_turnkey/sdk-types/v1WalletAccount/readme#curve) - -*** - -### organizationId - -> **organizationId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2740 - -The Organization the Account belongs to. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`organizationId`](../../../_turnkey/sdk-types/v1WalletAccount/readme#organizationid) - -*** - -### path - -> **path**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2748 - -Path used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`path`](../../../_turnkey/sdk-types/v1WalletAccount/readme#path) - -*** - -### pathFormat - -> **pathFormat**: `"PATH_FORMAT_BIP32"` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2746 - -Path format used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`pathFormat`](../../../_turnkey/sdk-types/v1WalletAccount/readme#pathformat) - -*** - -### publicKey? - -> `optional` **publicKey**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2756 - -The public component of this wallet account's underlying cryptographic key pair. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`publicKey`](../../../_turnkey/sdk-types/v1WalletAccount/readme#publickey) - -*** - -### signAndSendTransaction()? - -> `optional` **signAndSendTransaction**: (`unsignedTransaction`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:145 - -function to sign and send a transaction, returning the signed transaction as a string. - -#### Parameters - -##### unsignedTransaction - -`string` - -#### Returns - -`Promise`\<`string`\> - -*** - -### signMessage() - -> **signMessage**: (`message`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:143 - -function to sign a message, returning the hex signature as a string. - -#### Parameters - -##### message - -`string` - -#### Returns - -`Promise`\<`string`\> - -*** - -### signTransaction()? - -> `optional` **signTransaction**: (`unsignedTransaction`) => `Promise`\<`string`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:144 - -function to sign a transaction, returning the signed transaction as a string. - -#### Parameters - -##### unsignedTransaction - -`string` - -#### Returns - -`Promise`\<`string`\> - -*** - -### source - -> **source**: `Connected` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:142 - -source of the wallet account, which is always "connected". - -*** - -### updatedAt - -> **updatedAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2754 - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`updatedAt`](../../../_turnkey/sdk-types/v1WalletAccount/readme#updatedat) - -*** - -### walletAccountId - -> **walletAccountId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2738 - -Unique identifier for a given Wallet Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`walletAccountId`](../../../_turnkey/sdk-types/v1WalletAccount/readme#walletaccountid) - -*** - -### walletId - -> **walletId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2742 - -The Wallet the Account was derived from. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`walletId`](../../../_turnkey/sdk-types/v1WalletAccount/readme#walletid) diff --git a/generated-docs/sdks/react-wallet-kit/index/CreateSubOrgParams/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/CreateSubOrgParams/readme.mdx deleted file mode 100644 index 8ff0c9897..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/CreateSubOrgParams/readme.mdx +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: "CreateSubOrgParams" -mode: wide ---- - -# Interface: CreateSubOrgParams - -Defined in: core/dist/\_\_types\_\_/base.d.ts:196 - -CreateSubOrgParams defines the parameters to pass on sub-organization creation. - CreateSubOrgParams - -## Properties - -### apiKeys? - -> `optional` **apiKeys**: `object`[] - -Defined in: core/dist/\_\_types\_\_/base.d.ts:208 - -array of API keys to create. - -#### apiKeyName? - -> `optional` **apiKeyName**: `string` - -#### curveType? - -> `optional` **curveType**: [`v1ApiKeyCurve`](../../../_turnkey/sdk-types/v1ApiKeyCurve/readme) - -#### expirationSeconds? - -> `optional` **expirationSeconds**: `string` - -#### publicKey - -> **publicKey**: `string` - -*** - -### authenticators? - -> `optional` **authenticators**: `object`[] - -Defined in: core/dist/\_\_types\_\_/base.d.ts:201 - -array of authenticators to create. - -#### attestation - -> **attestation**: [`v1Attestation`](../../../_turnkey/sdk-types/v1Attestation/readme) - -#### authenticatorName - -> **authenticatorName**: `string` - -#### challenge - -> **challenge**: `string` - -*** - -### customWallet? - -> `optional` **customWallet**: `object` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:214 - -custom wallet to create. - -#### walletAccounts - -> **walletAccounts**: [`v1WalletAccountParams`](../../../_turnkey/sdk-types/v1WalletAccountParams/readme)[] - -#### walletName - -> **walletName**: `string` - -*** - -### oauthProviders? - -> `optional` **oauthProviders**: `Provider`[] - -Defined in: core/dist/\_\_types\_\_/base.d.ts:218 - -array of OAuth providers to create. - -*** - -### subOrgName? - -> `optional` **subOrgName**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:198 - -name of the sub-organization. - -*** - -### userEmail? - -> `optional` **userEmail**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:199 - -email of the user. - -*** - -### userName? - -> `optional` **userName**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:197 - -name of the user. - -*** - -### userPhoneNumber? - -> `optional` **userPhoneNumber**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:206 - -phone number of the user. - -*** - -### userTag? - -> `optional` **userTag**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:200 - -tag for the user. - -*** - -### verificationToken? - -> `optional` **verificationToken**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:207 - -verification token for the user. diff --git a/generated-docs/sdks/react-wallet-kit/index/EmbeddedWallet/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/EmbeddedWallet/readme.mdx deleted file mode 100644 index 8e4274d45..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/EmbeddedWallet/readme.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: "EmbeddedWallet" -mode: wide ---- - -# Interface: EmbeddedWallet - -Defined in: core/dist/\_\_types\_\_/base.d.ts:156 - -EmbeddedWallet represents a Turnkey embedded wallet. - EmbeddedWallet - -## Extends - -- [`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme) - -## Properties - -### accounts - -> **accounts**: `WalletAccount`[] - -Defined in: core/dist/\_\_types\_\_/base.d.ts:158 - -array of wallet accounts. - -*** - -### createdAt - -> **createdAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2729 - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`createdAt`](../../../_turnkey/sdk-types/v1Wallet/readme#createdat) - -*** - -### exported - -> **exported**: `boolean` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2732 - -True when a given Wallet is exported, false otherwise. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`exported`](../../../_turnkey/sdk-types/v1Wallet/readme#exported) - -*** - -### imported - -> **imported**: `boolean` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2734 - -True when a given Wallet is imported, false otherwise. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`imported`](../../../_turnkey/sdk-types/v1Wallet/readme#imported) - -*** - -### source - -> **source**: `Embedded` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:157 - -source of the wallet, which is always "embedded". - -*** - -### updatedAt - -> **updatedAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2730 - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`updatedAt`](../../../_turnkey/sdk-types/v1Wallet/readme#updatedat) - -*** - -### walletId - -> **walletId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2726 - -Unique identifier for a given Wallet. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`walletId`](../../../_turnkey/sdk-types/v1Wallet/readme#walletid) - -*** - -### walletName - -> **walletName**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2728 - -Human-readable name for a Wallet. - -#### Inherited from - -[`v1Wallet`](../../../_turnkey/sdk-types/v1Wallet/readme).[`walletName`](../../../_turnkey/sdk-types/v1Wallet/readme#walletname) diff --git a/generated-docs/sdks/react-wallet-kit/index/EmbeddedWalletAccount/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/EmbeddedWalletAccount/readme.mdx deleted file mode 100644 index dd083b6d7..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/EmbeddedWalletAccount/readme.mdx +++ /dev/null @@ -1,175 +0,0 @@ ---- -title: "EmbeddedWalletAccount" -mode: wide ---- - -# Interface: EmbeddedWalletAccount - -Defined in: core/dist/\_\_types\_\_/base.d.ts:129 - -EmbeddedWalletAccount represents a Turnkey embedded wallet account. - EmbeddedWalletAccount - -## Extends - -- [`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme) - -## Properties - -### address - -> **address**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2752 - -Address generated using the Wallet seed and Account parameters. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`address`](../../../_turnkey/sdk-types/v1WalletAccount/readme#address) - -*** - -### addressFormat - -> **addressFormat**: [`v1AddressFormat`](../../../_turnkey/sdk-types/v1AddressFormat/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2750 - -Address format used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`addressFormat`](../../../_turnkey/sdk-types/v1WalletAccount/readme#addressformat) - -*** - -### createdAt - -> **createdAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2753 - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`createdAt`](../../../_turnkey/sdk-types/v1WalletAccount/readme#createdat) - -*** - -### curve - -> **curve**: [`v1Curve`](../../../_turnkey/sdk-types/v1Curve/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2744 - -Cryptographic curve used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`curve`](../../../_turnkey/sdk-types/v1WalletAccount/readme#curve) - -*** - -### organizationId - -> **organizationId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2740 - -The Organization the Account belongs to. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`organizationId`](../../../_turnkey/sdk-types/v1WalletAccount/readme#organizationid) - -*** - -### path - -> **path**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2748 - -Path used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`path`](../../../_turnkey/sdk-types/v1WalletAccount/readme#path) - -*** - -### pathFormat - -> **pathFormat**: `"PATH_FORMAT_BIP32"` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2746 - -Path format used to generate the Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`pathFormat`](../../../_turnkey/sdk-types/v1WalletAccount/readme#pathformat) - -*** - -### publicKey? - -> `optional` **publicKey**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2756 - -The public component of this wallet account's underlying cryptographic key pair. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`publicKey`](../../../_turnkey/sdk-types/v1WalletAccount/readme#publickey) - -*** - -### source - -> **source**: `Embedded` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:130 - -source of the wallet account, which is always "embedded". - -*** - -### updatedAt - -> **updatedAt**: [`externaldatav1Timestamp`](../../../_turnkey/sdk-types/externaldatav1Timestamp/readme) - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2754 - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`updatedAt`](../../../_turnkey/sdk-types/v1WalletAccount/readme#updatedat) - -*** - -### walletAccountId - -> **walletAccountId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2738 - -Unique identifier for a given Wallet Account. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`walletAccountId`](../../../_turnkey/sdk-types/v1WalletAccount/readme#walletaccountid) - -*** - -### walletId - -> **walletId**: `string` - -Defined in: sdk-types/dist/\_\_generated\_\_/types.d.ts:2742 - -The Wallet the Account was derived from. - -#### Inherited from - -[`v1WalletAccount`](../../../_turnkey/sdk-types/v1WalletAccount/readme).[`walletId`](../../../_turnkey/sdk-types/v1WalletAccount/readme#walletid) diff --git a/generated-docs/sdks/react-wallet-kit/index/OtpType/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/OtpType/readme.mdx deleted file mode 100644 index 076453644..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/OtpType/readme.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "OtpType" -mode: wide ---- - -# Enumeration: OtpType - -Defined in: core/dist/\_\_types\_\_/base.d.ts:256 - -OtpType defines the type of OTP to use. - -## Enumeration Members - -### Email - -> **Email**: `"OTP_TYPE_EMAIL"` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:257 - -*** - -### Sms - -> **Sms**: `"OTP_TYPE_SMS"` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:258 diff --git a/generated-docs/sdks/react-wallet-kit/index/README.mdx b/generated-docs/sdks/react-wallet-kit/index/README.mdx deleted file mode 100644 index 95bef1736..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/README.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: "Index" -mode: wide ---- - -# index - -## Enumerations - -- [OtpType](OtpType/readme) -- [StamperType](StamperType/readme) - -## Interfaces - -- [BaseWalletInterface](BaseWalletInterface/readme) -- [ClientContextType](ClientContextType/readme) -- [ConnectedWallet](ConnectedWallet/readme) -- [ConnectedWalletAccount](ConnectedWalletAccount/readme) -- [CreateSubOrgParams](CreateSubOrgParams/readme) -- [EmbeddedWallet](EmbeddedWallet/readme) -- [EmbeddedWalletAccount](EmbeddedWalletAccount/readme) -- [TPasskeyStamperConfig](TPasskeyStamperConfig/readme) -- [TurnkeyHttpClientConfig](TurnkeyHttpClientConfig/readme) -- [TurnkeySDKClientConfig](TurnkeySDKClientConfig/readme) -- [TWalletManagerConfig](TWalletManagerConfig/readme) diff --git a/generated-docs/sdks/react-wallet-kit/index/StamperType/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/StamperType/readme.mdx deleted file mode 100644 index 350eecfe4..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/StamperType/readme.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "StamperType" -mode: wide ---- - -# Enumeration: StamperType - -Defined in: core/dist/\_\_types\_\_/base.d.ts:248 - -StamperType defines the type of stamper to use when stamping a request. - -## Enumeration Members - -### ApiKey - -> **ApiKey**: `"api-key"` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:249 - -*** - -### Passkey - -> **Passkey**: `"passkey"` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:250 - -*** - -### Wallet - -> **Wallet**: `"wallet"` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:251 diff --git a/generated-docs/sdks/react-wallet-kit/index/TPasskeyStamperConfig/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/TPasskeyStamperConfig/readme.mdx deleted file mode 100644 index c2099f703..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/TPasskeyStamperConfig/readme.mdx +++ /dev/null @@ -1,91 +0,0 @@ ---- -title: "TPasskeyStamperConfig" -mode: wide ---- - -# Interface: TPasskeyStamperConfig - -Defined in: core/dist/\_\_types\_\_/base.d.ts:308 - -TPasskeyStamperConfig defines the configuration for the passkey stamper. - TPasskeyStamperConfig - -## Properties - -### allowCredentials? - -> `optional` **allowCredentials**: `PublicKeyCredentialDescriptor`[] - -Defined in: core/dist/\_\_types\_\_/base.d.ts:312 - -list of credentials to pass. Defaults to empty. - -*** - -### extensions? - -> `optional` **extensions**: `Record`\<`string`, `unknown`\> - -Defined in: core/dist/\_\_types\_\_/base.d.ts:316 - -optional extensions. Defaults to empty. - -*** - -### rpId? - -> `optional` **rpId**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:309 - -The RPID ("Relying Party ID") for your app. This is automatically determined in web environments based on the current hostname. See https://github.com/f-23/react-native-passkey?tab=readme-ov-file#configuration to set this up for react-native. - -*** - -### rpName? - -> `optional` **rpName**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:313 - -name for the Relying Party (RP). This is used in the passkey creation flow on mobile. - -*** - -### timeout? - -> `optional` **timeout**: `number` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:310 - -timeout value in milliseconds. Defaults to 5 minutes. - -*** - -### userVerification? - -> `optional` **userVerification**: `UserVerificationRequirement` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:311 - -override for UV flag. Defaults to "preferred". - -*** - -### withPlatformKey? - -> `optional` **withPlatformKey**: `boolean` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:315 - -option to force platform passkeys on native platforms. - -*** - -### withSecurityKey? - -> `optional` **withSecurityKey**: `boolean` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:314 - -option to force security passkeys on native platforms. diff --git a/generated-docs/sdks/react-wallet-kit/index/TWalletManagerConfig/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/TWalletManagerConfig/readme.mdx deleted file mode 100644 index 14ba6dc52..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/TWalletManagerConfig/readme.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "TWalletManagerConfig" -mode: wide ---- - -# Interface: TWalletManagerConfig - -Defined in: core/dist/\_\_types\_\_/base.d.ts:329 - -TWalletManagerConfig defines the configuration for the wallet manager. - TWalletManagerConfig - -## Properties - -### chains - -> **chains**: `object` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:334 - -chains to support in the wallet manager. - -#### ethereum? - -> `optional` **ethereum**: `object` - -##### ethereum.native? - -> `optional` **ethereum.native**: `boolean` - -##### ethereum.walletConnectNamespaces? - -> `optional` **ethereum.walletConnectNamespaces**: `` `eip155:${string}` ``[] - -#### solana? - -> `optional` **solana**: `object` - -##### solana.native? - -> `optional` **solana.native**: `boolean` - -##### solana.walletConnectNamespaces? - -> `optional` **solana.walletConnectNamespaces**: `` `solana:${string}` ``[] - -*** - -### features? - -> `optional` **features**: `object` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:330 - -features to enable in the wallet manager. - -#### auth? - -> `optional` **auth**: `boolean` - -#### connecting? - -> `optional` **connecting**: `boolean` - -*** - -### walletConnect? - -> `optional` **walletConnect**: `object` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:344 - -configuration for WalletConnect. - -#### appMetadata - -> **appMetadata**: `object` - -##### appMetadata.description - -> **appMetadata.description**: `string` - -##### appMetadata.icons - -> **appMetadata.icons**: `string`[] - -##### appMetadata.name - -> **appMetadata.name**: `string` - -##### appMetadata.url - -> **appMetadata.url**: `string` - -#### projectId - -> **projectId**: `string` diff --git a/generated-docs/sdks/react-wallet-kit/index/TurnkeyHttpClientConfig/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/TurnkeyHttpClientConfig/readme.mdx deleted file mode 100644 index 5618405fc..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/TurnkeyHttpClientConfig/readme.mdx +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: "TurnkeyHttpClientConfig" -mode: wide ---- - -# Interface: TurnkeyHttpClientConfig - -Defined in: core/dist/\_\_types\_\_/base.d.ts:62 - -TurnkeyHttpClientConfig defines the configuration for the Turnkey HTTP client. - TurnkeyHttpClientConfig - -## Remarks - -This interface is used to configure the Turnkey HTTP client, which is responsible for making API -requests to Turnkey. It includes options for custom API key stamping, passkey stamping, wallet stamping, -and session management through a storage manager. -The `activityPoller` configuration allows for setting up a polling mechanism for activities, with options for the polling interval and number of retries. - -## Properties - -### activityPoller? - -> `optional` **activityPoller**: `TActivityPollerConfig` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:67 - -configuration for the activity poller. - -*** - -### apiBaseUrl - -> **apiBaseUrl**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:63 - -base URL for the Turnkey API. - -*** - -### apiKeyStamper? - -> `optional` **apiKeyStamper**: `TStamper` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:68 - -stamper for API keys. - -*** - -### authProxyConfigId? - -> `optional` **authProxyConfigId**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:66 - -ID for the auth proxy configuration. - -*** - -### authProxyUrl? - -> `optional` **authProxyUrl**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:65 - -URL for the auth proxy. - -*** - -### organizationId - -> **organizationId**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:64 - -ID of the organization. - -*** - -### passkeyStamper? - -> `optional` **passkeyStamper**: `TStamper` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:69 - -stamper for passkeys. - -*** - -### storageManager? - -> `optional` **storageManager**: `StorageBase` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:71 - -storage manager for session management. - -*** - -### walletStamper? - -> `optional` **walletStamper**: `TStamper` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:70 - -stamper for wallets. diff --git a/generated-docs/sdks/react-wallet-kit/index/TurnkeySDKClientConfig/readme.mdx b/generated-docs/sdks/react-wallet-kit/index/TurnkeySDKClientConfig/readme.mdx deleted file mode 100644 index 43f08ba65..000000000 --- a/generated-docs/sdks/react-wallet-kit/index/TurnkeySDKClientConfig/readme.mdx +++ /dev/null @@ -1,79 +0,0 @@ ---- -title: "TurnkeySDKClientConfig" -mode: wide ---- - -# Interface: TurnkeySDKClientConfig - -Defined in: core/dist/\_\_types\_\_/base.d.ts:89 - -TurnkeySDKClientConfig defines the configuration for the Turnkey SDK client. - TurnkeySDKClientConfig - -## Remarks - -This interface is used to configure the Turnkey SDK client, which is responsible for managing -interactions with the Turnkey API and handling user authentication and wallet management. -The `apiBaseUrl` is the endpoint for the Turnkey API, while `authProxyUrl` and `authProxyConfigId` are used for authentication proxy configurations. -The `organizationId` is required to identify the parent organization. -The `passkeyConfig` allows for configuring the passkey stamper, which is used for user authentication via passkeys. - -## Properties - -### apiBaseUrl? - -> `optional` **apiBaseUrl**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:90 - -base URL for the Turnkey API. - -*** - -### authProxyConfigId? - -> `optional` **authProxyConfigId**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:92 - -ID for the auth proxy configuration. - -*** - -### authProxyUrl? - -> `optional` **authProxyUrl**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:91 - -URL for the auth proxy. - -*** - -### organizationId - -> **organizationId**: `string` - -Defined in: core/dist/\_\_types\_\_/base.d.ts:93 - -ID of the organization. - -*** - -### passkeyConfig? - -> `optional` **passkeyConfig**: [`TPasskeyStamperConfig`](../TPasskeyStamperConfig/readme) - -Defined in: core/dist/\_\_types\_\_/base.d.ts:94 - -configuration for the passkey stamper. - -*** - -### walletConfig? - -> `optional` **walletConfig**: [`TWalletManagerConfig`](../TWalletManagerConfig/readme) - -Defined in: core/dist/\_\_types\_\_/base.d.ts:95 - -configuration for the wallet manager. diff --git a/generated-docs/sdks/readme.mdx b/generated-docs/sdks/readme.mdx deleted file mode 100644 index 8ca107ec7..000000000 --- a/generated-docs/sdks/readme.mdx +++ /dev/null @@ -1,168 +0,0 @@ ---- -title: "Sdks" -mode: wide ---- - -# Turnkey SDK - -[![js-build](https://github.com/tkhq/sdk/actions/workflows/js-build.yml/badge.svg)](https://github.com/tkhq/sdk/actions/workflows/js-build.yml) - -## Overview - -The Turnkey SDK includes functionality to interact with Turnkey in various contexts and ecosystems. It consists of three main NPM package groups. - -- the [Primary Turnkey Web SDK Packages](#primary-turnkey-web-sdk-packages) which expose the main functionality required to build Turnkey-powered applications in different web environments -- the [Chain/Ecosystem-Specific Signing Packages](#chainecosystem-specific-signing-sdk-packages) which expose signers with support for specific ecosystems, built on top of our Web SDK packages -- the [Advanced Functionality SDK Packages](#advanced-functionality-sdk-packages) which exposes lower level functionality that is leveraged by our Primary Web SDK Packages for those with highly-specific implementations looking to use them. - -The diagram below helps visualize the packages in our SDK organized by the functionality they expose. - -homepage screenshot - -## Primary Turnkey Web SDK Packages - -The following packages expose the main functionality required to build Turnkey-powered applications. Each package exposes functions, and/or client classes with methods that manage the process of authenticating requests to the Turnkey API in the contexts of a generic browser environment or react client environment, or a server environment. - -While these higher level packages are the main points of reference to be used while designing and building Turnkey applications, they wrap other packages with lower level functionality which we also expose separately for those who would like to explore them for more specialized use cases. These packages are listed and described below in the [Advanced Functionality SDK Packages](#advanced-functionality-sdk-packages) section. - -Our main web SDK packages are as follows: - -| Package | Description | NPM | Changelog | Docs | -| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | -------------------------------------------------------- | -| [@turnkey/sdk-browser](/packages/sdk-browser) | The `@turnkey/sdk-browser` package exposes functionality that lets developers build browser based applications that interact with the Turnkey API with different types of authentication. It consists of different clients that enable requests to the API to be authenticated via different auth methods like user sessions, passkeys and iFrames. It also contains methods to manage information and state related to authentication like auth bundles and sessions, retrieving user information and server signing API requests. | [![npm](https://img.shields.io/npm/v/@turnkey/http?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/sdk-browser) | [changelog](/packages/sdk-browser/changelog.md) | [Docs](https://docs.turnkey.com/sdks/javascript-browser) | -| [@turnkey/sdk-server](https://github.com/tkhq/sdk/tree/main/packages/sdk-server) | The `@turnkey/sdk-server` package exposes functionality that lets developers build server-side functionality for applications that interact with the Turnkey API with different types of authentication – allowing applications to authenticate users, manage sessions, and perform organizational operations securely and efficiently. It consists of an API Client and API Proxies that enable requests to the Turnkey API to be authenticated with the appropriate credentials. Specifically, the API Client manages requests signed by the user's authentication details, and the API proxies handle requests signed by the parent organization's authentication details. Use this package to handle server-side interactions for applications that interact with the Turnkey API. | [![npm](https://img.shields.io/npm/v/@turnkey/sdk-server?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/sdk-server) | [changelog](/packages/sdk-server/changelog.md) | [Docs](https://docs.turnkey.com/sdks/javascript-server) | -| [@turnkey/sdk-react](https://github.com/tkhq/sdk/tree/main/packages/sdk-react) | The `@turnkey/sdk-react` package wraps the functionality from the `@turnkey/sdk-browser` package to allow developers to build react based applications that interact with the Turnkey API with different types of authentication. It allows developers to use the same clients exposed in `@turnkey/sdk-browser` that enable requests to the API to be authenticated via different auth methods like user sessions, passkey and iFrames. It also contains the same methods to manage information and state related to authentication like auth bundles and sessions, retrieving user information and server signing API requests. Use this package when you're building React-based frontend applications that interact with the Turnkey API. | [![npm](https://img.shields.io/npm/v/@turnkey/sdk-react?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/sdk-react) | [changelog](/packages/sdk-react/changelog.md) | [Docs](https://docs.turnkey.com/sdks/react) | - -The diagram below helps visualize how each package can be used to devlop the appropriate service in your Turnkey Powered Application, and how Turnkey requests would flow between those services. - -homepage screenshot - -## Chain/Ecosystem-Specific Signing SDK Packages - -The following packages contain chain or ecosystem specific signers that take some of our [Primary Turnkey Web SDK Packages](#primary-turnkey-web-sdk-packages) (usually @turnkey/sdk-browser or @turnkey/sdk-server) and add additional support based on the signing process or transaction structure relevant to that specific chain or ecosystem. - -| Package | NPM | Description | Changelog | -| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | ----------------------------------------------------- | -| [`@turnkey/ethers`](/packages/ethers) | [![npm](https://img.shields.io/npm/v/@turnkey/ethers?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/ethers) | Turnkey Signer for Ethers | [changelog](/packages/ethers/changelog.md) | -| [`@turnkey/viem`](/packages/viem) | [![npm](https://img.shields.io/npm/v/@turnkey/viem?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/viem) | Turnkey Signer for Viem | [changelog](/packages/viem/changelog.md) | -| [`@turnkey/cosmjs`](/packages/cosmjs) | [![npm](https://img.shields.io/npm/v/@turnkey/cosmjs?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/cosmjs) | Turnkey Signer for CosmJS | [changelog](/packages/cosmjs/changelog.md) | -| [`@turnkey/solana`](/packages/solana) | [![npm](https://img.shields.io/npm/v/@turnkey/solana?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/solana) | Turnkey Signer for Solana | [changelog](/packages/solana/changelog.md) | -| [`@turnkey/eip-1193-provider`](/packages/eip-1193-provider) | [![npm](https://img.shields.io/npm/v/@turnkey/eip-1193-provider?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/eip-1193-provider) | Turnkey-compatible EIP-1193 Provider | [changelog](/packages/eip-1193-provider/changelog.md) | - -## Advanced Functionality SDK Packages - -For those with more specialized use cases, Turnkey exposes it's lower level-libraries stamping and encryption libraries to be used directly. Note: for most use-cases, these libraries are not meant to be used directly and we encourage working on designing your application mainly using our [Primary Turnkey Web SDK Packages](#primary-turnkey-web-sdk-packages) along with our [Chain and Ecosystem Specific SDK Packages](#chainecosystem-specific-signing-sdk-packages) as per your use case! - -### Request Stamping - -| Package | NPM | Description | Changelog | Docs | -| -------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------- | --------------------------------------------------------------- | -| [`@turnkey/http`](/packages/http) | [![npm](https://img.shields.io/npm/v/@turnkey/http?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/http) | Lower-level, fully typed HTTP client for interacting with Turnkey API | [changelog](/packages/http/changelog.md) | [Docs](https://docs.turnkey.com/sdks/advanced/turnkey-client) | -| [`@turnkey/api-key-stamper`](/packages/api-key-stamper) | [![npm](https://img.shields.io/npm/v/@turnkey/api-key-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/api-key-stamper) | Provide API key signatures over Turnkey requests | [changelog](/packages/api-key-stamper/changelog.md) | [Docs](https://docs.turnkey.com/sdks/advanced/api-key-stamper) | -| [`@turnkey/iframe-stamper`](/packages/iframe-stamper) | [![npm](https://img.shields.io/npm/v/@turnkey/iframe-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/iframe-stamper) | Provide API key signatures over Turnkey requests within iframe contexts | [changelog](/packages/iframe-stamper/changelog.md) | [Docs](https://docs.turnkey.com/sdks/advanced/iframe-stamper) | -| [`@turnkey/webauthn-stamper`](/packages/webauthn-stamper) | [![npm](https://img.shields.io/npm/v/@turnkey/webauthn-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/webauthn-stamper) | Provide Webauthn signatures over Turnkey requests | [changelog](/packages/webauthn-stamper/changelog.md) | [Docs](https://docs.turnkey.com/sdks/advanced/webauthn-stamper) | -| [`@turnkey/wallet-stamper`](/packages/wallet-stamper) | [![npm](https://img.shields.io/npm/v/@turnkey/wallet-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/wallet-stamper) | Provide wallet signatures over Turnkey requests | [changelog](/packages/wallet-stamper/changelog.md) | [Docs](https://docs.turnkey.com/sdks/advanced/wallet-stamper) | -| [`@turnkey/sdk-react-native-passkey-stamper`](/packages/react-native-passkey-stamper/) | [![npm](https://img.shields.io/npm/v/@turnkey/react-native-passkey-stamper?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/react-native-passkey-stamper) | Provide Passkey signatures over Turnkey requests in a React Native context | [changelog](/packages/react-native-passkey-stamper/changelog.md) | [Docs](https://docs.turnkey.com/sdks/react-native) | - -### Utilities - -| Package | NPM | Description | Changelog | -| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -------------------------------------------- | -| [`@turnkey/encoding`](/packages/encoding) | [![npm](https://img.shields.io/npm/v/@turnkey/encoding?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/encoding) | Encoding and decoding utilities, primarily for internal usage | [changelog](/packages/encoding/changelog.md) | -| [`@turnkey/crypto`](/packages/crypto) | [![npm](https://img.shields.io/npm/v/@turnkey/crypto?color=%234C48FF)](https://www.npmjs.com/package/@turnkey/crypto) | Cryptographic utilities for P256 keys, encryption, and decryption | [changelog](/packages/crypto/changelog.md) | - -## Code Examples - -### Instant examples (powered by Stackblitz) - -The following code examples have been loaded into Stackblitz web environments so you can test them out immediately - -| Example | Description | Stackblitz Link | -| ----------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| [`email-auth-local-storage`](/examples/email-auth-local-storage/) | A NextJS app demonstrating a complete email auth flow using a locally stored target embedded key | [Test it out on Stackblitz!](https://stackblitz.com/edit/stackblitz-starters-pyyw59) | -| [`with-eth-passkey-signers`](/examples/with-eth-passkey-signers/) | A NextJS app powering users to create suborgs and sign messages via Viem or Ethers | [Test it out on Stackblitz!](https://stackblitz.com/edit/stackblitz-starters-2psu3g) | -| [`with-solana`](/examples/with-solana/) | Create a new Solana address, then sign and broadcast a transaction on Solana's devnet | [Test it out on Stackblitz!](https://stackblitz.com/edit/stackblitz-starters-xeb93i) | -| [`with-solana-passkeys`](/examples/with-solana-passkeys/) | A NextJS app powering users to create suborgs, sign messages, and create transactions sponsored by the parent org using @turnkey/solana | [Test it out on Stackblitz!](https://stackblitz.com/edit/stackblitz-starters-h5pmnu) | - -### Other Code Examples - -The below examples will require a local installation of `node.js`. Follow the specific instructions in the respective readme's of each examples to run them! - -| Example | Description | -| ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`demo-consumer-wallet`](https://github.com/tkhq/demo-consumer-wallet) | A minimal consumer wallet app powered by Turnkey and WalletConnect | -| [`demo-passkey-wallet`](https://github.com/tkhq/demo-passkey-wallet) | A minimal consumer wallet app powered by Turnkey and passkeys | -| [`demo-ethers-passkeys`](https://github.com/tkhq/demo-ethers-passkeys) | A NextJS app that demonstrates how to use `@turnkey/ethers` to build a passkey-powered application | -| [`demo-viem-passkeys`](https://github.com/tkhq/demo-viem-passkeys) | A NextJS app that demonstrates how to use `@turnkey/viem` to build a passkey-powered application | -| [`react-native-demo-wallet`](https://github.com/tkhq/react-native-demo-wallet) | A React Native app that demonstrates how to use the Turnkey's JavaScript packages in a mobile environment to authenticate users, create wallets, export wallets, sign messages, and more | -| [`flutter-demo-app`](https://github.com/tkhq/dart-sdk/tree/main/examples/flutter-demo-app) | A Flutter app that demonstrates how to use the Turnkey's Flutter packages to authenticate users, create wallets, export wallets, sign messages, and more | -| [`deployer`](/examples/deployer/) | Compile and deploy a smart contract | -| [`email-auth`](/examples/email-auth/) | A NextJS app demonstrating a complete email auth flow using Turnkey iframes | -| [`wallet-import-export`](/examples/wallet-import-export/) | A NextJS app demonstrating complete wallet import and export flows | -| [`rebalancer`](/examples/rebalancer/) | A demo application which showcases an example of how to use Turnkey for managing multiple types of keys & users | -| [`sweeper`](/examples/sweeper/) | Sweep funds from one address to a different address | -| [`trading-runner`](/examples/trading-runner/) | A sample application demonstrating a trading operation, using various private keys, users, and policies, powered by Uniswap | -| [`with-ethers`](/examples/with-ethers/) | Create a new Ethereum address, then sign and broadcast a transaction using the Ethers signer with Infura | -| [`with-viem`](/examples/with-viem/) | Sign and broadcast a transaction using the Turnkey Custom Account and Infura | -| [`with-cosmjs`](/examples/with-cosmjs/) | Create a new Cosmos address, then sign and broadcast a transaction on Celestia testnet using the CosmJS signer | -| [`with-bitcoin`](/examples/with-bitcoin/) | Create a new wallet, derive a BTC address, create, sign, and broadcast a transaction using BitcoinJS and other external APIs | -| [`with-biconomy-aa`](/examples/with-biconomy-aa/) | Create a new wallet, connect a Turnkey wallet client to Biconomy Nexus, and create, sign, and broadcast an EIP-1559 transaction | -| [`with-zerodev-aa`](/examples/with-zerodev-aa/) | Create a new wallet, instantiate a Turnkey signer, create a ZeroDev kernel account and client, and broadcast a UserOp | -| [`with-gnosis`](/examples/with-gnosis/) | Create new Ethereum addresses, configure a 3/3 Gnosis safe, and create + execute a transaction from it | -| [`with-uniswap`](/examples/with-uniswap/) | Sign and broadcast a Uniswap v3 trade using the Ethers signer with Infura | -| [`with-nonce-manager`](/examples/with-nonce-manager/) | Create a new Ethereum address, then sign and broadcast multiple transactions in a sequential or optimistic manner | -| [`with-offline`](/examples/with-offline/) | Sign a Turnkey request in offline context | -| [`with-federated-passkeys`](/examples/with-federated-passkeys/) | A NextJS app that demonstrates how to use Turnkey to build a federated, webauthn powered authentication flow | -| [`with-eip-1193-provider`](/examples/with-eip-1193-provider/) | A NextJS app that demonstrates how to use Turnkey the `@turnkey/eip-1193-provider` in your app | -| [`with-wallet-stamper`](/examples/with-wallet-stamper/) | A NextJS app that demonstrates how to use Turnkey the `@turnkey/wallet-stamper` in your app | - -## Demos built with Turnkey - -### Demo Consumer Wallet ([code](https://github.com/tkhq/demo-consumer-wallet)) - -A minimal consumer wallet app powered by Turnkey. Behind the scenes, it uses [`@turnkey/ethers`](https://www.npmjs.com/package/@turnkey/ethers) for signing and WalletConnect (v1) for accessing dapps. - -https://github.com/tkhq/demo-consumer-wallet/assets/127255904/2c3409df-2d7c-4ec3-9aa8-e2944a0b0e0a - -See https://github.com/tkhq/demo-consumer-wallet for the code. - -### Demo Passkey Wallet ([code](https://github.com/tkhq/demo-passkey-wallet), [live link](https://wallet.tx.xyz)) - -A wallet application showing how users can register and authenticate using passkeys. -This demo uses the Turnkey API to create a new [Turnkey Sub-Organization](https://docs.turnkey.com/concepts/sub-organizations) for each user, create a testnet Ethereum address and send a transaction on Sepolia (ETH testnet). - -homepage screenshot - -See https://wallet.tx.xyz (and https://github.com/tkhq/demo-passkey-wallet for the code). - -### Demo Ethers Passkeys ([code](https://github.com/tkhq/demo-ethers-passkeys)) - -A simple application demonstrating how to create sub-organizations, create private keys, and sign with the [`@turnkey/ethers`](https://github.com/tkhq/sdk/tree/main/packages/ethers) signer, using passkeys. - -homepage screenshot - -See https://github.com/tkhq/demo-ethers-passkeys for the code. - -### Demo Viem Passkeys ([code](https://github.com/tkhq/demo-viem-passkeys)) - -A similar, simple application demonstrating how to create sub-organizations, create private keys, and sign with the [`@turnkey/viem`](https://github.com/tkhq/sdk/tree/main/packages/viem) signer, using passkeys. - -homepage screenshot - -See https://github.com/tkhq/demo-viem-passkeys for the code. - -### React Native Demo App ([code](https://github.com/tkhq/react-native-demo-wallet)) - -A React Native app that demonstrates how to use the Turnkey's JavaScript packages in a mobile environment to authenticate users, create wallets, export wallets, sign messages, and more - -https://github.com/user-attachments/assets/e4cff012-11e9-4636-b67a-5dbf75355832 - -See https://github.com/tkhq/react-native-demo-wallet for the code. - -### Flutter Demo App ([code](https://github.com/tkhq/dart-sdk/tree/main/examples/flutter-demo-app)) - -A Flutter app that demonstrates how to use the Turnkey's Flutter packages to authenticate users, create wallets, export wallets, sign messages, and more - -https://github.com/user-attachments/assets/3d583ed8-1eff-4101-ae43-3c76c655e635 - -See https://github.com/tkhq/dart-sdk/tree/main/examples/flutter-demo-app for the code diff --git a/generated-docs/sdks/sdk-browser/JavaScript_Browser/readme.mdx b/generated-docs/sdks/sdk-browser/JavaScript_Browser/readme.mdx deleted file mode 100644 index 18c0db298..000000000 --- a/generated-docs/sdks/sdk-browser/JavaScript_Browser/readme.mdx +++ /dev/null @@ -1,784 +0,0 @@ ---- -title: "JavaScript_Browser" -mode: wide ---- - -## Overview - -The [`@turnkey/sdk-browser`](https://www.npmjs.com/package/@turnkey/sdk-browser) package exposes functionality that lets developers build browser based applications that interact with the Turnkey API with different types of authentication. - -It consists of the `passkeyClient`, `iframeClient` and `walletClient` that enable requests to the API to be authenticated via different auth methods. It also contains methods to manage information and state related to authentication like auth bundles and sessions, retrieving user information and server signing API requests. - -If you are working with React - check out our [`@turnkey/sdk-react`](https://www.npmjs.com/package/@turnkey/sdk-react) package. - -## Installation - - - -```bash npm -npm install @turnkey/sdk-browser -``` - -```bash Yarn -yarn add @turnkey/sdk-browser -``` - - - -## Initializing - -```js -import { Turnkey } from "@turnkey/sdk-browser"; -const turnkey = new Turnkey({ - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}); -``` - -#### Parameters - - - -An object containing configuration settings for the Browser Client. - - - - - -The root organization that requests will be made from unless otherwise specified - - - - - -The base URL that API requests will be sent to (use [https://api.turnkey.com](https://api.turnkey.com) when making requests to Turnkey's API) - - - - - -The Relying Party ID used for WebAuthn flows (will default to the value returned from `window.location.hostname` unless otherwise specified) - - - - - -The URL to send requests that need to be signed from a backend codebase by the root organization's API key if using the `serverSign` flow. - - -Calls to Turnkey's API must be signed with a valid credential from the appropriate user and, from a browser client, can either be sent directly to Turnkey or proxied through a server. Turnkey's Browser SDK contains the following different clients that manage the process of validating these requests depending on the kind of authentication credential that is being used. - -## TurnkeyBrowserClient - -The `TurnkeyBrowserClient` wraps Turnkey's basic SDK client with browser session management functionality. This client allows you to create a read only session that only authenticates read requests, or a read write session. It uses local storage for session management. The constructor for `TurnkeyBrowserClient` optionally takes in `AuthClient` which tracks which client was used for the initial authentication, to be used for retrieval purposes. Each subclass of `TurnkeyBrowserClient` (including `TurnkeyPasskeyClient`, `TurnkeyIframeClient` and `TurnkeyWalletClient`) will also set this to the respective value when used. - -Below are all of the methods exposed by `TurnkeyBrowserClient` - -### `login()` - -Creates a read-only session for the current user, storing session details like userId, organizationId, sessionExpiry and which authentication client was used in local storage. This session allows for read-only actions within the Turnkey API. If you would like to instantiate a read only `TurnkeyBrowserClient` after logging in, you can use the [`currentUserSession()`](#currentusersession) method. - -```js -import { TurnkeyBrowserClient } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const browserClient = new TurnkeyBrowserClient(config); - -// Logs in to create a read-only session, storing the session in local storage -const readOnlySession = await browserClient.login({ organizationId: "org-id" }); -``` - -### `loginWithBundle()` - -Authenticate a user via the credential bundle emailed to them and creates a read-write session. - -```js -import { TurnkeyBrowserClient } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const browserClient = new TurnkeyBrowserClient(config); - -// Authenticate with a credential bundle from email -const session = await browserClient.loginWithBundle({ - bundle: "credential-bundle-from-email", - expirationSeconds: "900", // 15 minutes -}); -``` - -#### Parameters - - - An object containing the parameters to authenticate via a credential bundle. - - - - The credential bundle string emailed to the user. - - - - Specify the length of the session in seconds. Defaults to 900 seconds or 15 - minutes. - - - - The public key of the target user. This will be inferred from the - `TurnkeyIframeClient` if `targetPublicKey` is not provided. - - -### `loginWithPasskey()` - -Authenticate a user via Passkey and create a read-only or read-write session. - -```js -import { TurnkeyBrowserClient } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const browserClient = new TurnkeyBrowserClient(config); -const iframeClient = await turnkeySDK.iframeClient(); - -// Authenticate with a passkey to create a read-write session -const session = await browserClient.loginWithPasskey({ - sessionType: "READ_WRITE", - iframeClient: iframeClient, - expirationSeconds: "900", // 15 minutes -}); -``` - -#### Parameters - - - An object containing the parameters to authenticate via a Passkey. - - - - The type of session to be created. Either read-only or read-write. - - - - An instance of a `TurnkeyIframeClient`. - - - - Specify the length of the session in seconds. Defaults to 900 seconds or 15 - minutes. - - - - The public key of the target user. This will be inferred from the - `TurnkeyIframeClient` if `targetPublicKey` is not provided. - - -### `loginWithSession()` - -Log in with a session object created via a server action. The session can be either read-only or read-write. - -```js -import { TurnkeyBrowserClient } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const browserClient = new TurnkeyBrowserClient(config); - -// Login with a session created by a server -const loggedIn = await browserClient.loginWithSession(serverCreatedSession); -``` - -#### Parameters - - - An existing session to authenticate the user with. - - -### `loginWithWallet()` - -Login with an existing wallet e.g. Metamask. - -```js -import { TurnkeyBrowserClient } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const browserClient = new TurnkeyBrowserClient(config); -const iframeClient = await turnkeySDK.iframeClient(); - -// Login with a wallet to create a read-write session -const session = await browserClient.loginWithWallet({ - sessionType: "READ_WRITE", - iframeClient: iframeClient, - expirationSeconds: "900", // 15 minutes -}); -``` - -#### Parameters - - - An object containing the parameters to authenticate via a browser wallet. - - - - The type of session to be created. Either read-only or read-write. - - - - An instance of a `TurnkeyIframeClient`. - - - - Specify the length of the session in seconds. Defaults to 900 seconds or 15 - minutes. - - - - The public key of the target user. This will be inferred from the - `TurnkeyIframeClient` if `targetPublicKey` is not provided. - - -### `refreshSession()` - -Attempts to refresh an existing, active session and will extend the session expiry using the `expirationSeconds` parameter. - -```js -import { TurnkeyBrowserClient } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const browserClient = new TurnkeyBrowserClient(config); - -// Refresh the current session -const refreshedSession = await browserClient.refreshSession({ - sessionType: "READ_WRITE", - expirationSeconds: "900", // 15 minutes -}); -``` - -#### Parameters - - - An object containing the `RefreshSessionParams`. - - - - The type of `Session` that is being refreshed. - - - - Specify how long to extend the session. Defaults to 900 seconds or 15 minutes. - - - - The public key of the target user. This will be inferred from the - `TurnkeyIframeClient` if `targetPublicKey` is not provided. - - -### `loginWithReadWriteSession()` - -Creates a read-write session. This method infers the current user's organization ID and target userId. To be used in conjunction with an `iframeStamper`: the resulting session's credential bundle can be injected into an iframeStamper to create a session that enables both read and write requests. - -```js -import { TurnkeyBrowserClient } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const browserClient = new TurnkeyBrowserClient(config); - -// Logs in to create a read-write session, using a target embedded key and session expiration -const readWriteSession = await browserClient.loginWithReadWriteSession( - "target-embedded-key", - "900", // Session expires in 15 minutes - "user-id", -); -``` - -## TurnkeyPasskeyClient - -The `TurnkeyPasskeyClient` class extends `TurnkeyBrowserClient` and specializes it for user authentication through Passkeys, which leverage the WebAuthn standard for passwordless authentication. This class enables the implementation of strong, user-friendly authentication experiences in a web-based application without relying on passwords. TurnkeyPasskeyClient handles Passkey creation, session management with Passkeys and integrates with WebAuthn and Embedded API Keys. - -To see how to instantiate the `TurnkeyPasskeyClient`, [look here](#passkeyclient) - -Below are the methods exposed by the `TurnkeyPasskeyClient` - -### `createUserPasskey()` - -Creates a passkey for an end-user, handling lower-level configurations for the WebAuthn protocol, including challenges and user details. For more detailed examples using this method [look here](/embedded-wallets/code-examples/add-credential). - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const passkeyClient = turnkeySDK.passkeyClient(); - -// Creates a new user passkey with WebAuthn protocol details -const passkey = await passkeyClient.createUserPasskey({ - publicKey: { - rp: { name: "Example Relying Party" }, - user: { name: "testUser", displayName: "Test User" }, - }, -}); -``` - -### `createPasskeySession()` - -Uses Passkey authentication to create a read-write session, via an embedded API key, and stores + returns the resulting auth bundle that contains the encrypted API key. This auth bundle (also referred to as a credential bundle) can be injected into an iframeStamper, resulting in a touch-free authenticator. Unlike `loginWithReadWriteSession`, this method assumes the end-user's organization ID (i.e. the sub-organization ID) is already known. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const passkeyClient = turnkeySDK.passkeyClient(); - -// Creates a read-write session using a passkey with a specific expiration and organization ID -const session = await passkeyClient.createPasskeySession( - "user-id", - "target-embedded-key", - "1800", // Expire in 30 minutes - "org-id", -); -``` - -## TurnkeyIframeClient - -The `TurnkeyIframeClient` class extends `TurnkeyBrowserClient` such that it is specialized for use with an iframe-based session. Our iFrame stamping implementation leverages the postMessage communication mechanism to send and receive messages within the iframe, ensuring the credential does not leave its secure environment. This approach is particularly crucial in sensitive flows such as Email Auth, and Key or Wallet Export, where heightened security is required. For further information on our iframe stamping process, checkout our [iframeStamper package documentation](/sdks/advanced/iframe-stamper). - -To see how to instantiate the `TurnkeyIframeClient`, [look here](#iframeclient). - -Here are all of the methods exposed by `TurnkeyIframeClient` - -### `injectCredentialBundle()` - -Injects an encrypted credential bundle (API key or session token) directly into the iframe for session-based authentication and authorization. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const iframeClient = turnkeySDK.iframeClient(); - -// Injects a credential bundle into the iframe for session management -const success = await iframeClient.injectCredentialBundle( - "your-credential-bundle", -); -``` - -### `injectWalletExportBundle()` - -Injects a wallet export bundle into the iframe, associating it with a specified organization. This allows secure transfer of wallet credentials. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const iframeClient = turnkeySDK.iframeClient(); - -// Injects a credential bundle into the iframe for session management -const success = await iframeClient.injectWalletExportBundle( - "wallet-bundle", - "org-id", -); -``` - -### `injectKeyExportBundle()` - -Injects a key export bundle into the iframe, supporting optional key formats. This is useful for transferring specific key credentials securely. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const iframeClient = turnkeySDK.iframeClient(); - -// Injects a key export bundle with an optional key format -const success = await iframeClient.injectKeyExportBundle( - "key-bundle", - "org-id", - "PEM", -); -``` - -### `injectImportBundle()` - -Injects an import bundle into the iframe, associating it with a specific organization and user, enabling secure import of user credentials. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const iframeClient = turnkeySDK.iframeClient(); - -// Injects an import bundle for a specific organization and user -const success = await iframeClient.injectImportBundle( - "import-bundle", - "org-id", - "user-id", -); -``` - -### `extractWalletEncryptedBundle()` - -Extracts an encrypted wallet bundle from the iframe. Useful for securely retrieving wallet credentials from the iframe to the main application. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const iframeClient = turnkeySDK.iframeClient(); - -// Extracts the encrypted wallet bundle from the iframe -const walletBundle = await iframeClient.extractWalletEncryptedBundle(); -``` - -### `extractKeyEncryptedBundle()` - -Extracts an encrypted key bundle from the iframe, providing secure retrieval of key credentials. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -// Create a Passkey client instance -const iframeClient = turnkeySDK.iframeClient(); - -// Extracts the encrypted key bundle from the iframe -const keyBundle = await iframeClient.extractKeyEncryptedBundle(); -``` - -## TurnkeyWalletClient - -The `TurnkeyWalletClient` extends `TurnkeyBrowserClient` such that it is specialized for using a wallet to stamp and authenticate requests to the Turnkey API. This stamping process leverages your wallet's signature key to authenticate requests securely. - -### `getPublicKey()` - -This method enables easy access to the wallet public key from the `TurnkeyWalletClient` to be used in authentication flows. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; -import { EthereumWallet } from "@turnkey/wallet-stamper"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -const walletClient = turnkeySDK.walletClient(new EthereumWallet()); -const publicKey = await walletsClient.getPublicKey(); -``` - -### `getWalletInterface()` - -This method provides easy access to the full object that represents the wallet being used to stamp requests for this client. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; -import { EthereumWallet } from "@turnkey/wallet-stamper"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -const walletClient = turnkeySDK.walletClient(new EthereumWallet()); -const wallet = await walletsClient.getWalletInterface(); -``` - -## Top Level SDK Functions in `TurnkeyBrowserSDK` - -The `TurnkeyBrowserSDK` serves as the main entry point for interacting with Turnkey's services in a web browser environment. It contains methods to instantiate clients like the `TurnkeyPasskeyClient` and the `TurnkeyIframeClient`. manage information and state related to authentication like auth bundles and sessions, retrieving user information and server signing API requests.The client enables easy access to the wallet public key to be used for authentication flows. - -### `passkeyClient()` - -Creates an instance of TurnkeyPasskeyClient with a specified or default rpId (relying party ID). This client can prompt users to sign with a Passkey credential for authentication. If you'd like to use your Passkey client to proxy requests to your server, to be signed with parent organization credentials, include the server URL in the `serverSignUrl` parameter. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, - serverSignUrl: "https://your-server-sign-url.com", -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -const passkeyClient = turnkeySDK.passkeyClient(); -const walletsResponse = await passkeyClient.getWallets(); -``` - -### `iframeClient()` - -Creates an instance of `TurnkeyIframeClient` by initializing an iframe stamper with the specified iframeUrl and optional element ID. The iframe client is used to interact with a series of iframes hosted by Turnkey, designed for sensitive operations such as storing an expiring credential within the [Email Recovery](/authentication/email#recovery-flow) and [Email Auth](/authentication/email) flows, and facilitating Wallet [Import](/wallets/import-wallets) and [Export](/wallets/export-wallets). The code powering these iframes can be found at [https://github.com/tkhq/frames](https://github.com/tkhq/frames). If you'd like to use your iframe client to proxy requests to your server, to be signed with parent organization credentials, include the server URL in the `serverSignUrl` parameter. - -```js -import { Turnkey } from "@turnkey/sdk-browser"; - -const config = { - apiBaseUrl: "https://api.turnkey.com", - defaultOrganizationId: process.env.TURNKEY_ORGANIZATION_ID, - serverSignUrl: "https://your-server-sign-url.com", -}; - -// Create a client instance -const turnkeySDK = new Turnkey(config); - -const iframeClient = await turnkeySDK.iframeClient({ - iframeContainer: document.getElementById("