Repository navigation
tkey v18.0.0
This major release moves all 14 packages to the 2026 Q4 toolchain. Read the breaking changes before you upgrade.
Highlights
- New build toolchain. Library builds now use Vite+ and the 2026 Q4 toolchain.
- Simpler package output. Each package ships one bundled file per format.
- Stricter types. Public types now follow
strictNullChecks. Optional fields are now marked as optional. - Updated Torus stack.
@toruslabs/customauth23,@toruslabs/torus.js19,@toruslabs/eccrypto8,@toruslabs/metadata-helpers9,@toruslabs/http-helpers10,@toruslabs/fetch-node-details17, and@toruslabs/constants17.
Breaking changes
Toolchain and packaging
- Node
>=24.22.0and npm>=12are now required. Development and CI use Node 26 and the Node 24.22 floor. - Each package now ships one bundled file for each format:
dist/lib.cjs/index.jsanddist/lib.esm/index.js. Deep imports of other files underdist/no longer resolve. - The
typesentry now points atdist/lib.cjs/index.d.ts. The folderdist/lib.cjs/types/is removed. - The
@babel/runtimepeer dependency is removed.
Types
- Public types now follow
strictNullChecks. Fields that can be unset are optional:TKey.storeDeviceShare,AuthMetadata.privKey,ShareRequestArgs.encShareInTransit,ShareRequest.encShareInTransitandcustomInfo, andShareTransferModule.currentEncKeyandrequestStatusCheckId.TKey.metadataandTKey.lastFetchedCloudMetadataare typedMetadata | undefined. ITKey.secp256k1Keyis nowbigint | nullandITKey.ed25519Keyis nowUint8Array | null. The value isnulluntil you reconstruct or import the key.LocalTransitionSharesis nowArray<bigint | undefined>. Anundefinedentry marks the service-provider slot.IStorageLayer.setMetadataStreamaccepts the sameprivKeytype.
API
privKeyis now required inTKey.addLocalMetadataTransitionsandTKey.setAuthMetadataBulk.TKey.getTKeyStoreItemnow rejects when the item does not exist. Before, it resolvedundefined.- Removed
TKey._deleteTKeyStoreItemfromTKey,ITKeyApi, and the module API. No replacement is available. - The return type of
fromJSONon service providers and storage layers now includesundefined. These methods already returnedundefinedwhen the input did not match.
Package-specific
@tkey/service-provider-sfa: removeduseDkgfromWeb3AuthOptions. torus.js 19 removed the option. When a user has no key yet, the client now always makes the shares and imports them.@tkey/common-typesis now a dependency, because the published types import from it.@tkey/service-provider-torus:customAuthArgsnow follows CustomAuth 23.metadataUrlis removed. The optionalsentrypeer is now@sentry/core11.
Packages released
All packages are major-bumped to 18.0.0:
@tkey/chrome-storage, @tkey/common-types, @tkey/core, @tkey/default, @tkey/private-keys, @tkey/security-questions, @tkey/seed-phrase, @tkey/service-provider-base, @tkey/service-provider-sfa, @tkey/service-provider-torus, @tkey/share-serialization, @tkey/share-transfer, @tkey/storage-layer-torus, @tkey/web-storage
See the CHANGELOG.md file in each package folder for the full entry.
Full diff: v17.2.1...v18.0.0