Skip to content

v18.0.0

Latest

Choose a tag to compare

@chaitanyapotti chaitanyapotti released this 19 Nov 12:52
2b38c8d

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/customauth 23, @toruslabs/torus.js 19, @toruslabs/eccrypto 8, @toruslabs/metadata-helpers 9, @toruslabs/http-helpers 10, @toruslabs/fetch-node-details 17, and @toruslabs/constants 17.

Breaking changes

Toolchain and packaging

  • Node >=24.22.0 and npm >=12 are 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.js and dist/lib.esm/index.js. Deep imports of other files under dist/ no longer resolve.
  • The types entry now points at dist/lib.cjs/index.d.ts. The folder dist/lib.cjs/types/ is removed.
  • The @babel/runtime peer dependency is removed.

Types

  • Public types now follow strictNullChecks. Fields that can be unset are optional: TKey.storeDeviceShare, AuthMetadata.privKey, ShareRequestArgs.encShareInTransit, ShareRequest.encShareInTransit and customInfo, and ShareTransferModule.currentEncKey and requestStatusCheckId. TKey.metadata and TKey.lastFetchedCloudMetadata are typed Metadata | undefined.
  • ITKey.secp256k1Key is now bigint | null and ITKey.ed25519Key is now Uint8Array | null. The value is null until you reconstruct or import the key.
  • LocalTransitionShares is now Array<bigint | undefined>. An undefined entry marks the service-provider slot. IStorageLayer.setMetadataStream accepts the same privKey type.

API

  • privKey is now required in TKey.addLocalMetadataTransitions and TKey.setAuthMetadataBulk.
  • TKey.getTKeyStoreItem now rejects when the item does not exist. Before, it resolved undefined.
  • Removed TKey._deleteTKeyStoreItem from TKey, ITKeyApi, and the module API. No replacement is available.
  • The return type of fromJSON on service providers and storage layers now includes undefined. These methods already returned undefined when the input did not match.

Package-specific

  • @tkey/service-provider-sfa: removed useDkg from Web3AuthOptions. 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-types is now a dependency, because the published types import from it.
  • @tkey/service-provider-torus: customAuthArgs now follows CustomAuth 23. metadataUrl is removed. The optional sentry peer is now @sentry/core 11.

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