@open-e2ee/signal-protocol-sdk 0.2.3 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (601) hide show
  1. package/ADAPTERS.md +4 -4
  2. package/ARCHITECTURE.md +17 -16
  3. package/CHANGELOG.md +39 -0
  4. package/COMMERCIAL.md +6 -6
  5. package/NOTICE +1 -1
  6. package/README.md +44 -34
  7. package/SECURITY.md +16 -13
  8. package/TROUBLESHOOTING.md +5 -5
  9. package/blocking/README.md +6 -5
  10. package/client/README.md +5 -5
  11. package/device/README.md +8 -8
  12. package/dist/blocking/types.d.ts +2 -2
  13. package/dist/blocking/types.js +2 -2
  14. package/dist/client/client.d.ts +46 -45
  15. package/dist/client/client.d.ts.map +1 -1
  16. package/dist/client/client.js +61 -60
  17. package/dist/client/client.js.map +1 -1
  18. package/dist/client/config.d.ts +32 -32
  19. package/dist/client/constants.d.ts +7 -6
  20. package/dist/client/constants.d.ts.map +1 -1
  21. package/dist/client/constants.js +5 -4
  22. package/dist/client/constants.js.map +1 -1
  23. package/dist/client/dual-store.d.ts +2 -2
  24. package/dist/client/dual-store.js +2 -2
  25. package/dist/client/endorsement-manager.d.ts +14 -14
  26. package/dist/client/endorsement-manager.d.ts.map +1 -1
  27. package/dist/client/endorsement-manager.js +15 -15
  28. package/dist/client/endorsement-manager.js.map +1 -1
  29. package/dist/client/event-hooks.d.ts +16 -16
  30. package/dist/client/event-hooks.d.ts.map +1 -1
  31. package/dist/client/event-hooks.js +1 -1
  32. package/dist/client/event-hooks.js.map +1 -1
  33. package/dist/client/files.js +4 -4
  34. package/dist/client/files.js.map +1 -1
  35. package/dist/client/headless.d.ts +7 -7
  36. package/dist/client/headless.d.ts.map +1 -1
  37. package/dist/client/headless.js +4 -4
  38. package/dist/client/key-rotation-core.d.ts +19 -17
  39. package/dist/client/key-rotation-core.d.ts.map +1 -1
  40. package/dist/client/key-rotation-core.js +35 -31
  41. package/dist/client/key-rotation-core.js.map +1 -1
  42. package/dist/client/key-rotation.d.ts +8 -8
  43. package/dist/client/key-rotation.js +8 -8
  44. package/dist/client/media.d.ts +1 -1
  45. package/dist/client/messages.d.ts.map +1 -1
  46. package/dist/client/messages.js +13 -11
  47. package/dist/client/messages.js.map +1 -1
  48. package/dist/client/multi-device.d.ts +5 -4
  49. package/dist/client/multi-device.d.ts.map +1 -1
  50. package/dist/client/multi-device.js.map +1 -1
  51. package/dist/client/prekeys.d.ts +7 -7
  52. package/dist/client/prekeys.js +10 -10
  53. package/dist/client/prekeys.js.map +1 -1
  54. package/dist/client/relay-subscription.d.ts +3 -0
  55. package/dist/client/relay-subscription.d.ts.map +1 -1
  56. package/dist/client/relay-subscription.js +7 -4
  57. package/dist/client/relay-subscription.js.map +1 -1
  58. package/dist/client/retry-utils.d.ts +5 -6
  59. package/dist/client/retry-utils.d.ts.map +1 -1
  60. package/dist/client/retry-utils.js +5 -12
  61. package/dist/client/retry-utils.js.map +1 -1
  62. package/dist/client/retry.js +7 -7
  63. package/dist/client/retry.js.map +1 -1
  64. package/dist/client/sealed-sender-ops.d.ts +3 -3
  65. package/dist/client/sealed-sender-ops.js +5 -5
  66. package/dist/client/sealed-sender-ops.js.map +1 -1
  67. package/dist/client/sessions.d.ts +2 -2
  68. package/dist/client/sessions.js +2 -2
  69. package/dist/client/signal-service-cipher.d.ts +9 -9
  70. package/dist/client/signal-service-cipher.d.ts.map +1 -1
  71. package/dist/client/signal-service-cipher.js +41 -40
  72. package/dist/client/signal-service-cipher.js.map +1 -1
  73. package/dist/client/state.d.ts +1 -1
  74. package/dist/client/state.js +1 -1
  75. package/dist/client/types.d.ts +19 -19
  76. package/dist/client/types.d.ts.map +1 -1
  77. package/dist/device/connection.d.ts +1 -1
  78. package/dist/device/connection.js +2 -2
  79. package/dist/device/connection.js.map +1 -1
  80. package/dist/device/constants.d.ts +4 -4
  81. package/dist/device/constants.js +3 -3
  82. package/dist/device/device-id.d.ts +4 -4
  83. package/dist/device/device-id.js +4 -4
  84. package/dist/device/expo-metadata.d.ts +13 -11
  85. package/dist/device/expo-metadata.d.ts.map +1 -1
  86. package/dist/device/expo-metadata.js +13 -11
  87. package/dist/device/expo-metadata.js.map +1 -1
  88. package/dist/device/lifecycle/manager.d.ts +6 -6
  89. package/dist/device/lifecycle/manager.js +7 -7
  90. package/dist/device/lifecycle/types.d.ts +13 -13
  91. package/dist/device/lifecycle/types.d.ts.map +1 -1
  92. package/dist/device/lifecycle/utils.d.ts +2 -2
  93. package/dist/device/lifecycle/utils.js +5 -5
  94. package/dist/device/lifecycle/utils.js.map +1 -1
  95. package/dist/device/provisioning.d.ts +5 -4
  96. package/dist/device/provisioning.d.ts.map +1 -1
  97. package/dist/device/provisioning.js +5 -4
  98. package/dist/device/provisioning.js.map +1 -1
  99. package/dist/device/transfer.d.ts +2 -2
  100. package/dist/device/transfer.js +3 -3
  101. package/dist/device/transfer.js.map +1 -1
  102. package/dist/encoding/index.d.ts +3 -4
  103. package/dist/encoding/index.d.ts.map +1 -1
  104. package/dist/encoding/index.js.map +1 -1
  105. package/dist/files/index.d.ts +1 -1
  106. package/dist/files/index.js +1 -1
  107. package/dist/hooks/use-connection-presence.d.ts +1 -1
  108. package/dist/hooks/use-connection-presence.js +7 -7
  109. package/dist/hooks/use-connection-presence.js.map +1 -1
  110. package/dist/hooks/use-group-membership.d.ts +2 -2
  111. package/dist/hooks/use-group-membership.d.ts.map +1 -1
  112. package/dist/hooks/use-group-membership.js +6 -6
  113. package/dist/hooks/use-group-membership.js.map +1 -1
  114. package/dist/hooks/use-key-rotation.js +3 -3
  115. package/dist/hooks/use-key-rotation.js.map +1 -1
  116. package/dist/hooks/use-single-flight.d.ts +2 -2
  117. package/dist/hooks/use-single-flight.js +1 -1
  118. package/dist/index.d.ts +4 -3
  119. package/dist/index.d.ts.map +1 -1
  120. package/dist/index.js +22 -4
  121. package/dist/index.js.map +1 -1
  122. package/dist/internal/crypto/ec/ed25519.d.ts +6 -6
  123. package/dist/internal/crypto/ec/ed25519.js +6 -6
  124. package/dist/internal/crypto/ec/x25519-validation.d.ts.map +1 -1
  125. package/dist/internal/crypto/ec/x25519-validation.js +4 -2
  126. package/dist/internal/crypto/ec/x25519-validation.js.map +1 -1
  127. package/dist/internal/crypto/index.d.ts +2 -0
  128. package/dist/internal/crypto/index.d.ts.map +1 -1
  129. package/dist/internal/crypto/index.js +2 -0
  130. package/dist/internal/crypto/index.js.map +1 -1
  131. package/dist/internal/crypto/kdf/hkdf.d.ts +9 -8
  132. package/dist/internal/crypto/kdf/hkdf.d.ts.map +1 -1
  133. package/dist/internal/crypto/kdf/hkdf.js +11 -10
  134. package/dist/internal/crypto/kdf/hkdf.js.map +1 -1
  135. package/dist/internal/crypto/key-prefix.d.ts +3 -3
  136. package/dist/internal/crypto/key-prefix.js +3 -3
  137. package/dist/internal/crypto/pq/kyber.d.ts +7 -7
  138. package/dist/internal/crypto/pq/kyber.js +10 -10
  139. package/dist/internal/crypto/pq/kyber.js.map +1 -1
  140. package/dist/internal/crypto/random.d.ts +1 -1
  141. package/dist/internal/crypto/random.js +1 -1
  142. package/dist/internal/crypto/symmetric/aes-gcm-siv.js +1 -1
  143. package/dist/internal/crypto/symmetric/aes.js +4 -4
  144. package/dist/internal/crypto/symmetric/aes.js.map +1 -1
  145. package/dist/internal/crypto/symmetric/mac.d.ts +1 -1
  146. package/dist/internal/crypto/symmetric/mac.js +3 -3
  147. package/dist/internal/crypto/symmetric/padding.js +1 -1
  148. package/dist/internal/crypto/symmetric/padding.js.map +1 -1
  149. package/dist/internal/crypto/symmetric/streaming-aead.d.ts +7 -1
  150. package/dist/internal/crypto/symmetric/streaming-aead.d.ts.map +1 -1
  151. package/dist/internal/crypto/symmetric/streaming-aead.js +10 -4
  152. package/dist/internal/crypto/symmetric/streaming-aead.js.map +1 -1
  153. package/dist/internal/crypto/utils.d.ts +2 -2
  154. package/dist/internal/crypto/utils.d.ts.map +1 -1
  155. package/dist/internal/crypto/utils.js +16 -14
  156. package/dist/internal/crypto/utils.js.map +1 -1
  157. package/dist/internal/crypto/validation.d.ts +4 -4
  158. package/dist/internal/crypto/validation.js +2 -2
  159. package/dist/internal/encoding/proto/envelope.d.ts +1 -1
  160. package/dist/internal/encoding/proto/envelope.js +1 -1
  161. package/dist/internal/encoding/proto/index.d.ts +4 -4
  162. package/dist/internal/encoding/proto/index.js +4 -4
  163. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts +28 -16
  164. package/dist/internal/encoding/proto/pq-ratchet-serialize.d.ts.map +1 -1
  165. package/dist/internal/encoding/proto/pq-ratchet-serialize.js +30 -18
  166. package/dist/internal/encoding/proto/pq-ratchet-serialize.js.map +1 -1
  167. package/dist/internal/encoding/proto/primitives.d.ts +45 -35
  168. package/dist/internal/encoding/proto/primitives.d.ts.map +1 -1
  169. package/dist/internal/encoding/proto/primitives.js +54 -43
  170. package/dist/internal/encoding/proto/primitives.js.map +1 -1
  171. package/dist/internal/encoding/proto/sender-key-message.d.ts +2 -2
  172. package/dist/internal/encoding/proto/sender-key-message.js +2 -2
  173. package/dist/internal/encoding/proto/signal-message.d.ts +13 -13
  174. package/dist/internal/encoding/proto/signal-message.d.ts.map +1 -1
  175. package/dist/internal/encoding/proto/signal-message.js +13 -13
  176. package/dist/internal/encoding/proto/signal-message.js.map +1 -1
  177. package/dist/internal/groups/access-control.d.ts +5 -5
  178. package/dist/internal/groups/access-control.js +6 -6
  179. package/dist/internal/groups/access-control.js.map +1 -1
  180. package/dist/internal/groups/change-actions.d.ts +4 -4
  181. package/dist/internal/groups/change-actions.js +3 -3
  182. package/dist/internal/groups/encrypted-state.js +1 -1
  183. package/dist/internal/groups/encrypted-state.js.map +1 -1
  184. package/dist/internal/groups/group-id.d.ts +1 -1
  185. package/dist/internal/groups/manager.d.ts +24 -23
  186. package/dist/internal/groups/manager.d.ts.map +1 -1
  187. package/dist/internal/groups/manager.js +40 -36
  188. package/dist/internal/groups/manager.js.map +1 -1
  189. package/dist/internal/groups/server-engine.d.ts +29 -21
  190. package/dist/internal/groups/server-engine.d.ts.map +1 -1
  191. package/dist/internal/groups/server-engine.js +55 -50
  192. package/dist/internal/groups/server-engine.js.map +1 -1
  193. package/dist/internal/groups/trust-root.d.ts +2 -2
  194. package/dist/internal/groups/trust-root.js +2 -2
  195. package/dist/internal/groups/types.d.ts +4 -4
  196. package/dist/internal/groups/types.d.ts.map +1 -1
  197. package/dist/internal/groups/wire.d.ts +6 -7
  198. package/dist/internal/groups/wire.d.ts.map +1 -1
  199. package/dist/internal/groups/wire.js +6 -7
  200. package/dist/internal/groups/wire.js.map +1 -1
  201. package/dist/internal/manager/manager.d.ts +14 -12
  202. package/dist/internal/manager/manager.d.ts.map +1 -1
  203. package/dist/internal/manager/manager.js +47 -41
  204. package/dist/internal/manager/manager.js.map +1 -1
  205. package/dist/internal/protocol/double-ratchet/chains.d.ts +8 -6
  206. package/dist/internal/protocol/double-ratchet/chains.d.ts.map +1 -1
  207. package/dist/internal/protocol/double-ratchet/chains.js +10 -8
  208. package/dist/internal/protocol/double-ratchet/chains.js.map +1 -1
  209. package/dist/internal/protocol/double-ratchet/index.d.ts +2 -2
  210. package/dist/internal/protocol/double-ratchet/index.js +2 -2
  211. package/dist/internal/protocol/double-ratchet/ratchet.d.ts +4 -4
  212. package/dist/internal/protocol/double-ratchet/ratchet.js +6 -6
  213. package/dist/internal/protocol/pqxdh/pqxdh.d.ts +21 -18
  214. package/dist/internal/protocol/pqxdh/pqxdh.d.ts.map +1 -1
  215. package/dist/internal/protocol/pqxdh/pqxdh.js +48 -42
  216. package/dist/internal/protocol/pqxdh/pqxdh.js.map +1 -1
  217. package/dist/internal/protocol/sealed-sender/decryption-v2.js +5 -5
  218. package/dist/internal/protocol/sealed-sender/decryption-v2.js.map +1 -1
  219. package/dist/internal/protocol/sealed-sender/decryption.d.ts.map +1 -1
  220. package/dist/internal/protocol/sealed-sender/decryption.js +11 -8
  221. package/dist/internal/protocol/sealed-sender/decryption.js.map +1 -1
  222. package/dist/internal/protocol/sealed-sender/delivery-token.d.ts +2 -2
  223. package/dist/internal/protocol/sealed-sender/delivery-token.js +2 -2
  224. package/dist/internal/protocol/sealed-sender/encryption-v2.js +1 -1
  225. package/dist/internal/protocol/sealed-sender/encryption-v2.js.map +1 -1
  226. package/dist/internal/protocol/sealed-sender/encryption.d.ts +2 -2
  227. package/dist/internal/protocol/sealed-sender/encryption.js +2 -2
  228. package/dist/internal/protocol/sealed-sender/proto/index.d.ts +25 -23
  229. package/dist/internal/protocol/sealed-sender/proto/index.d.ts.map +1 -1
  230. package/dist/internal/protocol/sealed-sender/proto/index.js +32 -30
  231. package/dist/internal/protocol/sealed-sender/proto/index.js.map +1 -1
  232. package/dist/internal/protocol/sealed-sender/trust-root.d.ts +10 -9
  233. package/dist/internal/protocol/sealed-sender/trust-root.d.ts.map +1 -1
  234. package/dist/internal/protocol/sealed-sender/trust-root.js +10 -9
  235. package/dist/internal/protocol/sealed-sender/trust-root.js.map +1 -1
  236. package/dist/internal/protocol/sealed-sender/types.d.ts +13 -14
  237. package/dist/internal/protocol/sealed-sender/types.d.ts.map +1 -1
  238. package/dist/internal/protocol/sealed-sender/types.js +7 -8
  239. package/dist/internal/protocol/sealed-sender/types.js.map +1 -1
  240. package/dist/internal/protocol/sealed-sender/v2-binary.d.ts +1 -1
  241. package/dist/internal/protocol/sealed-sender/v2-binary.js +2 -2
  242. package/dist/internal/protocol/sealed-sender/v2-binary.js.map +1 -1
  243. package/dist/internal/protocol/sender-keys/manager.d.ts +16 -14
  244. package/dist/internal/protocol/sender-keys/manager.d.ts.map +1 -1
  245. package/dist/internal/protocol/sender-keys/manager.js +37 -34
  246. package/dist/internal/protocol/sender-keys/manager.js.map +1 -1
  247. package/dist/internal/protocol/spqr/braid-serialize.d.ts +6 -6
  248. package/dist/internal/protocol/spqr/braid-serialize.js +5 -5
  249. package/dist/internal/protocol/spqr/braid-serialize.js.map +1 -1
  250. package/dist/internal/protocol/spqr/braid.d.ts +3 -3
  251. package/dist/internal/protocol/spqr/braid.js +7 -7
  252. package/dist/internal/protocol/spqr/braid.js.map +1 -1
  253. package/dist/internal/protocol/spqr/index.js +1 -1
  254. package/dist/internal/protocol/spqr/index.js.map +1 -1
  255. package/dist/internal/protocol/spqr/ml-kem-braid/chunk-domain.d.ts +3 -3
  256. package/dist/internal/protocol/spqr/ml-kem-braid/chunk-domain.js +3 -3
  257. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js +1 -1
  258. package/dist/internal/protocol/spqr/ml-kem-braid/incremental-kem.js.map +1 -1
  259. package/dist/internal/protocol/spqr/ml-kem-braid/kdf.d.ts +1 -1
  260. package/dist/internal/protocol/spqr/ml-kem-braid/kdf.js +1 -1
  261. package/dist/internal/protocol/spqr/ml-kem-braid/kdf.js.map +1 -1
  262. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.d.ts +4 -3
  263. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.d.ts.map +1 -1
  264. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.js +4 -3
  265. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/arithmetic.js.map +1 -1
  266. package/dist/internal/protocol/spqr/ml-kem-braid/noble-pq/index.js +2 -2
  267. package/dist/internal/protocol/spqr/ml-kem-braid/progress.d.ts +1 -1
  268. package/dist/internal/protocol/spqr/ml-kem-braid/progress.js +1 -1
  269. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts +15 -7
  270. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.d.ts.map +1 -1
  271. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js +15 -7
  272. package/dist/internal/protocol/spqr/ml-kem-braid/rs/codec.js.map +1 -1
  273. package/dist/internal/protocol/spqr/ml-kem-braid/rs/galois/field.js +1 -1
  274. package/dist/internal/protocol/spqr/ml-kem-braid/rs/polynomial.d.ts +3 -3
  275. package/dist/internal/protocol/spqr/ml-kem-braid/rs/polynomial.js +1 -1
  276. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.d.ts +7 -7
  277. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js +11 -11
  278. package/dist/internal/protocol/spqr/ml-kem-braid/serialize.js.map +1 -1
  279. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.d.ts +1 -1
  280. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js +6 -6
  281. package/dist/internal/protocol/spqr/ml-kem-braid/state-machine.js.map +1 -1
  282. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts +2 -2
  283. package/dist/internal/protocol/spqr/ml-kem-braid/types.d.ts.map +1 -1
  284. package/dist/internal/protocol/spqr/ml-kem-braid/types.js.map +1 -1
  285. package/dist/internal/protocol/spqr/serialize.d.ts +12 -12
  286. package/dist/internal/protocol/spqr/serialize.js +5 -5
  287. package/dist/internal/protocol/spqr/spqr.d.ts +6 -6
  288. package/dist/internal/protocol/spqr/spqr.d.ts.map +1 -1
  289. package/dist/internal/protocol/spqr/spqr.js +47 -42
  290. package/dist/internal/protocol/spqr/spqr.js.map +1 -1
  291. package/dist/internal/protocol/spqr/validate.d.ts +1 -1
  292. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts +12 -12
  293. package/dist/internal/protocol/triple-ratchet/ratchet.d.ts.map +1 -1
  294. package/dist/internal/protocol/triple-ratchet/ratchet.js +11 -11
  295. package/dist/internal/protocol/triple-ratchet/ratchet.js.map +1 -1
  296. package/dist/internal/protocol/username/hash.d.ts.map +1 -1
  297. package/dist/internal/protocol/username/hash.js +6 -4
  298. package/dist/internal/protocol/username/hash.js.map +1 -1
  299. package/dist/internal/protocol/version.d.ts +3 -3
  300. package/dist/internal/protocol/version.js +1 -1
  301. package/dist/internal/protocol/x3dh/x3dh.d.ts +16 -16
  302. package/dist/internal/protocol/x3dh/x3dh.d.ts.map +1 -1
  303. package/dist/internal/protocol/x3dh/x3dh.js +15 -15
  304. package/dist/internal/protocol/x3dh/x3dh.js.map +1 -1
  305. package/dist/internal/protocol/zk/credentials/attributes.d.ts +7 -7
  306. package/dist/internal/protocol/zk/credentials/attributes.js +7 -7
  307. package/dist/internal/protocol/zk/credentials/credentials.d.ts +1 -1
  308. package/dist/internal/protocol/zk/credentials/credentials.js +1 -1
  309. package/dist/internal/protocol/zk/credentials/endorsements.d.ts +11 -11
  310. package/dist/internal/protocol/zk/credentials/endorsements.js +14 -14
  311. package/dist/internal/protocol/zk/credentials/issuance.d.ts +5 -1
  312. package/dist/internal/protocol/zk/credentials/issuance.d.ts.map +1 -1
  313. package/dist/internal/protocol/zk/credentials/issuance.js +5 -1
  314. package/dist/internal/protocol/zk/credentials/issuance.js.map +1 -1
  315. package/dist/internal/protocol/zk/credentials/presentation.d.ts +16 -16
  316. package/dist/internal/protocol/zk/credentials/presentation.d.ts.map +1 -1
  317. package/dist/internal/protocol/zk/credentials/presentation.js +18 -18
  318. package/dist/internal/protocol/zk/credentials/presentation.js.map +1 -1
  319. package/dist/internal/protocol/zk/groups/auth-credential.d.ts +22 -16
  320. package/dist/internal/protocol/zk/groups/auth-credential.d.ts.map +1 -1
  321. package/dist/internal/protocol/zk/groups/auth-credential.js +19 -14
  322. package/dist/internal/protocol/zk/groups/auth-credential.js.map +1 -1
  323. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.d.ts +4 -4
  324. package/dist/internal/protocol/zk/groups/client-zk-group-cipher.js +4 -4
  325. package/dist/internal/protocol/zk/groups/group-params.d.ts +2 -2
  326. package/dist/internal/protocol/zk/groups/group-params.js +2 -2
  327. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts +10 -9
  328. package/dist/internal/protocol/zk/groups/group-send-endorsement.d.ts.map +1 -1
  329. package/dist/internal/protocol/zk/groups/group-send-endorsement.js +9 -8
  330. package/dist/internal/protocol/zk/groups/group-send-endorsement.js.map +1 -1
  331. package/dist/internal/protocol/zk/groups/lizard.d.ts +1 -1
  332. package/dist/internal/protocol/zk/groups/lizard.js +4 -4
  333. package/dist/internal/protocol/zk/groups/lizard.js.map +1 -1
  334. package/dist/internal/protocol/zk/groups/profile-key-commitment.d.ts +3 -3
  335. package/dist/internal/protocol/zk/groups/profile-key-commitment.js +3 -3
  336. package/dist/internal/protocol/zk/groups/profile-key-credential.d.ts +11 -11
  337. package/dist/internal/protocol/zk/groups/profile-key-credential.js +7 -7
  338. package/dist/internal/protocol/zk/groups/profile-key-encryption.d.ts +2 -2
  339. package/dist/internal/protocol/zk/groups/profile-key-encryption.js +2 -2
  340. package/dist/internal/protocol/zk/groups/profile-key-struct.d.ts +2 -2
  341. package/dist/internal/protocol/zk/groups/profile-key-struct.js +2 -2
  342. package/dist/internal/protocol/zk/groups/profile-key-version.d.ts +2 -2
  343. package/dist/internal/protocol/zk/groups/profile-key-version.js +2 -2
  344. package/dist/internal/protocol/zk/groups/server-params.d.ts +1 -1
  345. package/dist/internal/protocol/zk/groups/server-params.js +1 -1
  346. package/dist/internal/protocol/zk/groups/uid-encryption.d.ts +4 -4
  347. package/dist/internal/protocol/zk/groups/uid-encryption.js +4 -4
  348. package/dist/internal/protocol/zk/groups/uid-struct.d.ts +2 -2
  349. package/dist/internal/protocol/zk/groups/uid-struct.js +3 -3
  350. package/dist/internal/protocol/zk/groups/uid-struct.js.map +1 -1
  351. package/dist/internal/protocol/zk/proofs/args.d.ts +3 -3
  352. package/dist/internal/protocol/zk/proofs/args.js +3 -3
  353. package/dist/internal/protocol/zk/proofs/sho-sha256.d.ts +3 -3
  354. package/dist/internal/protocol/zk/proofs/sho-sha256.js +3 -3
  355. package/dist/internal/protocol/zk/proofs/sho.d.ts +8 -7
  356. package/dist/internal/protocol/zk/proofs/sho.d.ts.map +1 -1
  357. package/dist/internal/protocol/zk/proofs/sho.js +8 -7
  358. package/dist/internal/protocol/zk/proofs/sho.js.map +1 -1
  359. package/dist/internal/protocol/zk/proofs/statement.d.ts +8 -6
  360. package/dist/internal/protocol/zk/proofs/statement.d.ts.map +1 -1
  361. package/dist/internal/protocol/zk/proofs/statement.js +8 -6
  362. package/dist/internal/protocol/zk/proofs/statement.js.map +1 -1
  363. package/dist/internal/sesame/manager.d.ts +23 -19
  364. package/dist/internal/sesame/manager.d.ts.map +1 -1
  365. package/dist/internal/sesame/manager.js +64 -54
  366. package/dist/internal/sesame/manager.js.map +1 -1
  367. package/dist/internal/sesame/types.d.ts +28 -25
  368. package/dist/internal/sesame/types.d.ts.map +1 -1
  369. package/dist/internal/sesame/types.js +2 -2
  370. package/dist/internal/sesame/types.js.map +1 -1
  371. package/dist/internal/sesame/validation.d.ts +2 -2
  372. package/dist/internal/sesame/validation.js +3 -3
  373. package/dist/internal/sesame/validation.js.map +1 -1
  374. package/dist/internal/session/builder.d.ts +8 -8
  375. package/dist/internal/session/builder.js +22 -22
  376. package/dist/internal/session/builder.js.map +1 -1
  377. package/dist/internal/session/cipher.d.ts +3 -3
  378. package/dist/internal/session/cipher.d.ts.map +1 -1
  379. package/dist/internal/session/cipher.js +51 -40
  380. package/dist/internal/session/cipher.js.map +1 -1
  381. package/dist/internal/session/decryption.js +11 -9
  382. package/dist/internal/session/decryption.js.map +1 -1
  383. package/dist/internal/session/factory.js +1 -1
  384. package/dist/internal/session/factory.js.map +1 -1
  385. package/dist/internal/session/handshake.d.ts +4 -4
  386. package/dist/internal/session/handshake.js +4 -4
  387. package/dist/internal/session/keys.d.ts +3 -4
  388. package/dist/internal/session/keys.d.ts.map +1 -1
  389. package/dist/internal/session/keys.js.map +1 -1
  390. package/dist/internal/session/ratchet.d.ts +8 -8
  391. package/dist/internal/session/ratchet.js +10 -10
  392. package/dist/internal/session/ratchet.js.map +1 -1
  393. package/dist/internal/session/session-resolver.d.ts +6 -6
  394. package/dist/internal/session/session-resolver.js +6 -6
  395. package/dist/internal/session/state.d.ts +12 -12
  396. package/dist/internal/session/state.d.ts.map +1 -1
  397. package/dist/internal/session/state.js +7 -7
  398. package/dist/internal/session/types.d.ts +20 -20
  399. package/dist/internal/session/types.d.ts.map +1 -1
  400. package/dist/internal/session/types.js +3 -3
  401. package/dist/internal/session/validation.d.ts +1 -1
  402. package/dist/internal/session/validation.js +4 -4
  403. package/dist/internal/session/validation.js.map +1 -1
  404. package/dist/keys/branded.d.ts +12 -12
  405. package/dist/keys/branded.js +3 -3
  406. package/dist/keys/generation.d.ts +4 -4
  407. package/dist/keys/generation.js +4 -4
  408. package/dist/keys/identity.d.ts +7 -7
  409. package/dist/keys/identity.d.ts.map +1 -1
  410. package/dist/keys/identity.js +7 -7
  411. package/dist/keys/identity.js.map +1 -1
  412. package/dist/keys/types.d.ts +16 -16
  413. package/dist/keys/types.d.ts.map +1 -1
  414. package/dist/layers.d.ts +1 -1
  415. package/dist/layers.js +1 -1
  416. package/dist/local/store/expo/adapter.d.ts +8 -8
  417. package/dist/local/store/expo/adapter.js +10 -10
  418. package/dist/local/store/expo/adapter.js.map +1 -1
  419. package/dist/local/store/expo/database-key.d.ts +7 -7
  420. package/dist/local/store/expo/database-key.js +7 -7
  421. package/dist/local/store/expo/key-storage.d.ts +1 -1
  422. package/dist/local/store/expo/key-storage.js +4 -4
  423. package/dist/local/store/expo/key-storage.js.map +1 -1
  424. package/dist/local/store/expo/models/kyber-prekey-used.d.ts +6 -6
  425. package/dist/local/store/expo/models/kyber-prekey-used.js +3 -3
  426. package/dist/local/store/expo/models/kyber-prekey.d.ts +1 -1
  427. package/dist/local/store/expo/models/kyber-prekey.js +1 -1
  428. package/dist/local/store/expo/models/message-record.d.ts +2 -2
  429. package/dist/local/store/expo/models/message-record.d.ts.map +1 -1
  430. package/dist/local/store/expo/models/message-record.js +1 -1
  431. package/dist/local/store/expo/models/message-record.js.map +1 -1
  432. package/dist/local/store/expo/models/sender-key.d.ts +11 -10
  433. package/dist/local/store/expo/models/sender-key.d.ts.map +1 -1
  434. package/dist/local/store/expo/models/sender-key.js +11 -10
  435. package/dist/local/store/expo/models/sender-key.js.map +1 -1
  436. package/dist/local/store/expo/schema.d.ts +2 -2
  437. package/dist/local/store/expo/schema.js +2 -2
  438. package/dist/local/store/expo/secure-store-options.d.ts +1 -1
  439. package/dist/local/store/memory/adapter.d.ts +2 -2
  440. package/dist/local/store/memory/adapter.js +12 -12
  441. package/dist/local/store/memory/adapter.js.map +1 -1
  442. package/dist/local/store/node/adapter.d.ts.map +1 -1
  443. package/dist/local/store/node/adapter.js +5 -4
  444. package/dist/local/store/node/adapter.js.map +1 -1
  445. package/dist/local/store/node/database-key.d.ts +8 -8
  446. package/dist/local/store/node/database-key.js +10 -10
  447. package/dist/local/store/node/database-key.js.map +1 -1
  448. package/dist/local/store/node/database.d.ts +5 -5
  449. package/dist/local/store/node/database.js +11 -11
  450. package/dist/local/store/node/database.js.map +1 -1
  451. package/dist/local/store/react-native/adapter.d.ts +6 -6
  452. package/dist/local/store/react-native/adapter.d.ts.map +1 -1
  453. package/dist/local/store/react-native/adapter.js +35 -32
  454. package/dist/local/store/react-native/adapter.js.map +1 -1
  455. package/dist/local/store/react-native/backend-conformance.d.ts +11 -10
  456. package/dist/local/store/react-native/backend-conformance.d.ts.map +1 -1
  457. package/dist/local/store/react-native/backend-conformance.js +13 -12
  458. package/dist/local/store/react-native/backend-conformance.js.map +1 -1
  459. package/dist/local/store/react-native/index.d.ts +1 -1
  460. package/dist/local/store/react-native/reference-backend.d.ts +14 -13
  461. package/dist/local/store/react-native/reference-backend.d.ts.map +1 -1
  462. package/dist/local/store/react-native/reference-backend.js +15 -14
  463. package/dist/local/store/react-native/reference-backend.js.map +1 -1
  464. package/dist/local/store/react-native/storage.d.ts +3 -3
  465. package/dist/local/store/web/adapter.d.ts +3 -3
  466. package/dist/local/store/web/adapter.d.ts.map +1 -1
  467. package/dist/local/store/web/adapter.js +30 -31
  468. package/dist/local/store/web/adapter.js.map +1 -1
  469. package/dist/local/store/web/index.d.ts +1 -1
  470. package/dist/local/vault/index.d.ts +2 -2
  471. package/dist/media/index.d.ts +11 -11
  472. package/dist/media/index.js +9 -9
  473. package/dist/profile/contact-state.d.ts +1 -1
  474. package/dist/profile/contact-state.js +1 -1
  475. package/dist/profile/profile-key.d.ts +2 -2
  476. package/dist/profile/profile-key.js +7 -6
  477. package/dist/profile/profile-key.js.map +1 -1
  478. package/dist/remote/object-store/index.d.ts +1 -1
  479. package/dist/remote/object-store/s3/storage.d.ts +1 -1
  480. package/dist/remote/object-store/types.d.ts +4 -4
  481. package/dist/remote/object-store/types.d.ts.map +1 -1
  482. package/dist/remote/relay/convex/backend.d.ts +4 -4
  483. package/dist/remote/relay/convex/backend.js +3 -3
  484. package/dist/remote/relay/convex/backend.js.map +1 -1
  485. package/dist/remote/relay/convex/component/accounts.d.ts +15 -13
  486. package/dist/remote/relay/convex/component/accounts.d.ts.map +1 -1
  487. package/dist/remote/relay/convex/component/accounts.js +31 -28
  488. package/dist/remote/relay/convex/component/accounts.js.map +1 -1
  489. package/dist/remote/relay/convex/component/certificates.js +1 -1
  490. package/dist/remote/relay/convex/component/cleanup.js +7 -7
  491. package/dist/remote/relay/convex/component/cleanup.js.map +1 -1
  492. package/dist/remote/relay/convex/component/convex.config.d.ts.map +1 -1
  493. package/dist/remote/relay/convex/component/convex.config.js +10 -8
  494. package/dist/remote/relay/convex/component/convex.config.js.map +1 -1
  495. package/dist/remote/relay/convex/component/devices.d.ts +21 -20
  496. package/dist/remote/relay/convex/component/devices.d.ts.map +1 -1
  497. package/dist/remote/relay/convex/component/devices.js +24 -23
  498. package/dist/remote/relay/convex/component/devices.js.map +1 -1
  499. package/dist/remote/relay/convex/component/groups.js +6 -6
  500. package/dist/remote/relay/convex/component/groups.js.map +1 -1
  501. package/dist/remote/relay/convex/component/messages.d.ts.map +1 -1
  502. package/dist/remote/relay/convex/component/messages.js +89 -82
  503. package/dist/remote/relay/convex/component/messages.js.map +1 -1
  504. package/dist/remote/relay/convex/component/provisioning.d.ts +3 -3
  505. package/dist/remote/relay/convex/component/provisioning.d.ts.map +1 -1
  506. package/dist/remote/relay/convex/component/provisioning.js +17 -16
  507. package/dist/remote/relay/convex/component/provisioning.js.map +1 -1
  508. package/dist/remote/relay/convex/component/runtime.d.ts.map +1 -1
  509. package/dist/remote/relay/convex/component/runtime.js +4 -2
  510. package/dist/remote/relay/convex/component/runtime.js.map +1 -1
  511. package/dist/remote/relay/convex/component/schema.js +25 -24
  512. package/dist/remote/relay/convex/component/schema.js.map +1 -1
  513. package/dist/remote/relay/convex/group-server.d.ts +3 -3
  514. package/dist/remote/relay/convex/group-server.js +3 -3
  515. package/dist/remote/relay/convex/relay.d.ts +3 -3
  516. package/dist/remote/relay/convex/relay.d.ts.map +1 -1
  517. package/dist/remote/relay/convex/relay.js +18 -17
  518. package/dist/remote/relay/convex/relay.js.map +1 -1
  519. package/dist/remote/relay/convex/types.d.ts +7 -7
  520. package/dist/remote/relay/convex/types.js +4 -4
  521. package/dist/remote/relay/memory/adapter.js +9 -9
  522. package/dist/remote/relay/memory/adapter.js.map +1 -1
  523. package/dist/remote/relay/types.d.ts +27 -27
  524. package/dist/remote/relay/types.d.ts.map +1 -1
  525. package/dist/safety/fingerprint.d.ts +7 -6
  526. package/dist/safety/fingerprint.d.ts.map +1 -1
  527. package/dist/safety/fingerprint.js +5 -4
  528. package/dist/safety/fingerprint.js.map +1 -1
  529. package/dist/safety/index.d.ts +6 -5
  530. package/dist/safety/index.d.ts.map +1 -1
  531. package/dist/safety/index.js +7 -6
  532. package/dist/safety/index.js.map +1 -1
  533. package/dist/safety/protobuf.js +2 -2
  534. package/dist/safety/protobuf.js.map +1 -1
  535. package/dist/safety/url.d.ts +5 -5
  536. package/dist/safety/url.js +6 -6
  537. package/dist/types/address.d.ts +2 -2
  538. package/dist/types/address.js +2 -2
  539. package/dist/types/api.d.ts +78 -73
  540. package/dist/types/api.d.ts.map +1 -1
  541. package/dist/types/errors.d.ts +63 -403
  542. package/dist/types/errors.d.ts.map +1 -1
  543. package/dist/types/errors.js +62 -537
  544. package/dist/types/errors.js.map +1 -1
  545. package/dist/types/messages.d.ts +16 -16
  546. package/dist/types/messages.d.ts.map +1 -1
  547. package/dist/types/messages.js +7 -7
  548. package/dist/types/messages.js.map +1 -1
  549. package/dist/types/protocol-config.d.ts +52 -49
  550. package/dist/types/protocol-config.d.ts.map +1 -1
  551. package/dist/types/protocol-config.js +36 -34
  552. package/dist/types/protocol-config.js.map +1 -1
  553. package/dist/types/protocol-constants.d.ts +2 -2
  554. package/dist/types/protocol-constants.js +2 -2
  555. package/dist/types/session.d.ts +62 -61
  556. package/dist/types/session.d.ts.map +1 -1
  557. package/dist/types/session.js +13 -14
  558. package/dist/types/session.js.map +1 -1
  559. package/dist/types/trust.d.ts +8 -8
  560. package/dist/types/trust.js +3 -3
  561. package/dist/utils/retry.d.ts.map +1 -1
  562. package/dist/utils/retry.js +2 -4
  563. package/dist/utils/retry.js.map +1 -1
  564. package/docs/ASSURANCE.md +82 -74
  565. package/docs/CLIENT_COMPOSITION.md +19 -15
  566. package/docs/DEVIATIONS.md +507 -425
  567. package/docs/DOCUMENTATION_STANDARDS.md +24 -24
  568. package/docs/E2EE.md +45 -42
  569. package/docs/ERROR_HANDLING.md +29 -105
  570. package/docs/GETTING_STARTED.md +24 -25
  571. package/docs/INTERFACES.md +27 -18
  572. package/docs/PACKAGE_SURFACE.md +23 -21
  573. package/docs/PROTOCOL_POLICY.md +19 -13
  574. package/docs/RECIPES.md +4 -4
  575. package/docs/SECURITY.md +72 -60
  576. package/encoding/README.md +2 -2
  577. package/files/README.md +1 -1
  578. package/groups/README.md +4 -3
  579. package/hooks/README.md +2 -2
  580. package/keys/README.md +15 -14
  581. package/local/store/README.md +82 -67
  582. package/local/store/expo/README.md +17 -12
  583. package/local/store/memory/README.md +4 -3
  584. package/local/store/node/README.md +8 -6
  585. package/local/store/react-native/README.md +14 -12
  586. package/local/store/web/README.md +31 -26
  587. package/local/vault/README.md +4 -4
  588. package/media/README.md +6 -5
  589. package/package.json +1 -1
  590. package/profile/README.md +7 -7
  591. package/remote/README.md +20 -18
  592. package/remote/object-store/README.md +8 -4
  593. package/remote/object-store/convex-r2/README.md +3 -3
  594. package/remote/object-store/s3/README.md +10 -5
  595. package/remote/relay/convex/README.md +5 -5
  596. package/remote/relay/convex/component/README.md +145 -124
  597. package/remote/relay/memory/README.md +6 -5
  598. package/safety/README.md +1 -1
  599. package/sealed-sender/README.md +3 -2
  600. package/types/README.md +1 -1
  601. package/utils/README.md +4 -4
@@ -4,7 +4,7 @@
4
4
  > [Adapters](../ADAPTERS.md)
5
5
 
6
6
  The Signal Protocol SDK keeps platform and backend infrastructure behind
7
- explicit TypeScript interfaces. The client owns protocol coordination; the host
7
+ explicit TypeScript interfaces. The client owns protocol coordination. The host
8
8
  application owns persistence, authentication, authorization, and product
9
9
  policy.
10
10
 
@@ -46,15 +46,15 @@ const client = await createSignalProtocolClient({
46
46
  A production implementation must:
47
47
 
48
48
  - preserve compare-and-swap and transaction semantics for trust and session
49
- transitions;
50
- - consume one-time prekeys atomically with the corresponding session commit;
51
- - persist exact device/session ownership metadata;
49
+ transitions.
50
+ - consume one-time prekeys atomically with the corresponding session commit.
51
+ - persist exact device/session ownership metadata.
52
52
  - treat account reset as a coordinated lifecycle across protocol records,
53
- bootstrap secrets, backups, and application state; and
53
+ bootstrap secrets, backups, and application state.
54
54
  - avoid placing decrypted application messages in the protocol store.
55
55
 
56
- Available adapters and their status are documented in the
57
- [local-store guide](../local/store/README.md).
56
+ The [local-store guide](../local/store/README.md) lists the available adapters
57
+ and their status.
58
58
 
59
59
  ## `ISignalProtocolLocalSecretVault`
60
60
 
@@ -100,11 +100,16 @@ const relay: ISignalProtocolRelayServer = convexRelay({
100
100
  });
101
101
  ```
102
102
 
103
- The application backend must authenticate every caller, derive ownership from
104
- trusted server context, authorize reads and writes, atomically consume one-time
105
- prekeys, allocate linked-device identifiers, and apply retention and abuse
106
- controls. Client-supplied user identifiers are routing inputs, not proof of
107
- identity.
103
+ The application backend must:
104
+
105
+ - authenticate every caller
106
+ - derive ownership from trusted server context
107
+ - authorize reads and writes
108
+ - atomically consume one-time prekeys
109
+ - allocate linked-device identifiers
110
+ - apply retention and abuse controls
111
+
112
+ A client-supplied user identifier is a routing input, not proof of identity.
108
113
 
109
114
  The relay stores public protocol material, ciphertext, and required routing
110
115
  metadata. It must not require device private keys or decrypted message content.
@@ -136,10 +141,14 @@ authenticated principal + retry requestId
136
141
  -> private provider key
137
142
  ```
138
143
 
139
- It must keep provider credentials and keys off the client, enforce ciphertext
140
- size and content-type policy, make upload completion idempotent, and authorize
141
- every download and deletion. See the
142
- [remote object-store guide](../remote/object-store/README.md).
144
+ It must:
145
+
146
+ - keep provider credentials and keys off the client
147
+ - enforce ciphertext size and content-type policy
148
+ - make upload completion idempotent
149
+ - authorize every download and deletion
150
+
151
+ See the [remote object-store guide](../remote/object-store/README.md).
143
152
 
144
153
  ## Application callbacks
145
154
 
@@ -169,8 +178,8 @@ const client = await createSignalProtocolClient({
169
178
  ```
170
179
 
171
180
  Callbacks may update application databases, caches, UI state, and telemetry.
172
- They must not be treated as a transactional extension of a completed protocol
173
- state update unless the specific API says so.
181
+ Never treat them as a transactional extension of a completed protocol state
182
+ update, unless the specific API says so.
174
183
 
175
184
  ## Choosing an integration
176
185
 
@@ -5,28 +5,29 @@
5
5
  > [Security Model](./SECURITY.md) | [API Reference](./api/README.md)
6
6
 
7
7
  This document is the complete public surface of
8
- `@open-e2ee/signal-protocol-sdk`: what the root package exports, every
9
- supported subpath, the adapter implementations that ship with the package, and
10
- the vocabulary the rest of the documentation assumes.
8
+ `@open-e2ee/signal-protocol-sdk`. It lists what the root package exports, every
9
+ supported subpath, and the adapter implementations that ship with the package.
10
+ It also defines the vocabulary the rest of the documentation assumes.
11
11
 
12
12
  ## Core model
13
13
 
14
14
  - `createSignalProtocolClient()` is the recommended app-facing entry point.
15
15
  - `SignalProtocolClient` is the primary class returned by the factory.
16
- - `storage` is required and owns local encryption state for one user/device.
17
- - `relay` is optional for local development, but real messaging apps use it for
16
+ - Every client requires `storage`, which owns local encryption state for one
17
+ user/device.
18
+ - `relay` is optional for local development. Real messaging apps use it for
18
19
  key sync, message delivery, device fanout, and linked-device workflows.
19
- - Secure post-quantum defaults are enabled without extra configuration.
20
- - Identity trust is pinned to one versioned X25519 + Ed25519 composite tuple
21
- per `(userId, identityType)`; first contact remains unverified TOFU.
20
+ - The client enables secure post-quantum defaults without extra configuration.
21
+ - The SDK pins identity trust to one versioned X25519 + Ed25519 composite tuple
22
+ per `(userId, identityType)`. First contact remains unverified TOFU.
22
23
  - The root package is intentionally core-only. Platform and backend adapters
23
24
  live on explicit subpaths.
24
25
 
25
- OpenE2EE is the project and package namespace; it is not the name of a single
26
+ OpenE2EE is the project and package namespace. It is not the name of a single
26
27
  protocol client. The protocol-specific package and client names leave that
27
28
  namespace clear for other E2EE protocol implementations, such as a future
28
29
  [Messaging Layer Security (MLS)](https://www.rfc-editor.org/rfc/rfc9420.html)
29
- package, without implying that one client spans multiple protocols.
30
+ package. They do not imply that one client spans multiple protocols.
30
31
 
31
32
  ## Setup sequence
32
33
 
@@ -131,7 +132,7 @@ Expo storage or Convex helpers.
131
132
 
132
133
  - **Client**: one running app instance for one account and one device.
133
134
  - **User ID**: your app's stable account identifier.
134
- - **Device ID**: `1` for the primary device; linked devices use `2-5`.
135
+ - **Device ID**: `1` for the primary device. Linked devices use `2-5`.
135
136
  - **Storage**: local encrypted state needed to keep conversations working across
136
137
  restarts.
137
138
  - **Relay**: server-side public keys, device lists, encrypted envelope delivery,
@@ -169,7 +170,7 @@ Expo storage or Convex helpers.
169
170
  - `InMemorySignalProtocolStore` / `inMemoryStore()` for local development
170
171
  - custom implementations via `ISignalProtocolLocalStore`
171
172
 
172
- ### Remote object storage
173
+ ### Remote object store
173
174
 
174
175
  - `ConvexR2ObjectStore` via
175
176
  `@open-e2ee/signal-protocol-sdk/remote/object-store/convex-r2`
@@ -182,13 +183,13 @@ Expo storage or Convex helpers.
182
183
  - custom implementations via `SignalProtocolRemoteObjectStore`
183
184
 
184
185
  `ConvexR2ObjectStore` is a client adapter for authenticated app-owned Convex
185
- functions that wrap `@convex-dev/r2`; it is not the Convex component itself.
186
+ functions that wrap `@convex-dev/r2`. It is not the Convex component itself.
186
187
  The application continues to own component installation, mounting,
187
188
  configuration, authentication, authorization, persistence, credentials, and
188
189
  the R2 bucket. The optional server helper owns only generic broker mechanics.
189
190
  Both concrete adapters keep provider credentials in the application backend.
190
191
 
191
- Remote object storage is a normal first-class integration point for encrypted
192
+ The remote object store is a normal integration point for encrypted
192
193
  attachments and files, not a niche or internal-only adapter. Use
193
194
  `attachment.transfer` when your app has a foreground, background, resumable, or
194
195
  platform-native byte transfer implementation. The Signal Protocol package still
@@ -198,12 +199,13 @@ Object stores can return signed upload headers, and stores that return
198
199
  `protocol: 'tus'` automatically use the built-in resumable TUS transfer helper.
199
200
  You can also pass `media.createTusMediaAttachmentTransfer()` explicitly when
200
201
  your app wants to tune the TUS fetch implementation or chunk size. Download
201
- credentials can also return signed headers. For JavaScript runtimes that need
202
- resumable downloads, `media.createByteRangeMediaAttachmentTransfer()` performs
203
- strict HTTP range requests, validates `Content-Range`, persists checkpoints, and
204
- resumes only when your app provides a partial-byte store for the previous
205
- ciphertext prefix. Native background download integrations should implement the
206
- same `MediaAttachmentTransfer` seam.
202
+ credentials can also return signed headers.
203
+
204
+ For JavaScript runtimes that need resumable downloads, use `media.createByteRangeMediaAttachmentTransfer()`. It
205
+ makes strict HTTP range requests, validates `Content-Range`, and persists
206
+ checkpoints. It resumes only when your app provides a partial-byte store for the
207
+ previous ciphertext prefix. Native background download integrations should
208
+ implement the same `MediaAttachmentTransfer` seam.
207
209
 
208
210
  ## Design notes
209
211
 
@@ -228,7 +230,7 @@ same `MediaAttachmentTransfer` seam.
228
230
  - [Keys and identity](../keys/README.md)
229
231
  - [Local stores](../local/store/README.md)
230
232
  - [Local secret vault](../local/vault/README.md)
231
- - [Remote relay and object storage](../remote/README.md)
233
+ - [Relay and remote object store](../remote/README.md)
232
234
  - [Encrypted media](../media/README.md)
233
235
  - [Encrypted files](../files/README.md)
234
236
  - [Groups](../groups/README.md)
@@ -2,11 +2,11 @@
2
2
 
3
3
  > Navigation: [README](../README.md) | [ARCHITECTURE](../ARCHITECTURE.md) | [Security](./SECURITY.md) | [Getting Started](./GETTING_STARTED.md) | **Protocol Policy** | [Deviations](./DEVIATIONS.md)
4
4
 
5
- This document covers **which protocol modes run** and which fail closed. For
6
- **how the profile differs from the published specifications and from
7
- `libsignal`** — the composite identity, the Ed25519-instead-of-XEdDSA signature
8
- scheme, the ML-KEM Braid `hek` operand order, and the rest — see
9
- [Deviations](./DEVIATIONS.md).
5
+ This document covers **which protocol modes run** and which fail closed.
6
+ [Deviations](./DEVIATIONS.md) covers **how the profile differs from the
7
+ published specifications and from `libsignal`**. That includes the composite
8
+ identity, the Ed25519-instead-of-XEdDSA signature scheme, the ML-KEM Braid
9
+ `hek` operand order, and every other difference.
10
10
 
11
11
  The public Signal Protocol client policy is:
12
12
 
@@ -70,11 +70,13 @@ await createSignalProtocolClient({
70
70
  ```
71
71
 
72
72
  `braid: 'required'` uses the specification-defined ML-KEM Braid SPQR profile
73
- and is the default. HEK is `SHA3-256(ek_seed || ek_vector)`; that operand order
73
+ and is the default. HEK is `SHA3-256(ek_seed || ek_vector)`. That operand order
74
74
  is part of the public compatibility boundary. It follows the ML-KEM Braid
75
- specification text and is the reverse of `libsignal`'s implementation, which means
76
- braid sessions do not interoperate with `libsignal`'s and the KEM in this mode is not
77
- stock FIPS 203 — see [Deviations §4.1](./DEVIATIONS.md#41-the-hek-operand-order-diverges).
75
+ specification text and reverses `libsignal`'s implementation. Braid sessions
76
+ therefore do not interoperate with `libsignal`'s, and the KEM in this mode is
77
+ not stock FIPS 203.
78
+
79
+ See [Deviations §4.1](./DEVIATIONS.md#41-the-hek-operand-order-diverges).
78
80
 
79
81
  ```ts
80
82
  await createSignalProtocolClient({
@@ -115,10 +117,14 @@ compatibility fallback. Do not set `protocolStrategy.allowClassicalFallback`
115
117
  when `protocol.postQuantum` is present.
116
118
 
117
119
  The advanced `protocolStrategy.onBraidProgress` callback reports ML-KEM Braid
118
- chunk progress after every braid-mode send and receive: the chunks this side has
119
- carried in the current epoch, the chunks the open transfers account for, the
120
- epoch, and whether the operation produced the epoch secret. A direct-mode
121
- session never raises it.
120
+ chunk progress after every braid-mode send and receive:
121
+
122
+ - the chunks this side carried in the current epoch
123
+ - the chunks the open transfers account for
124
+ - the epoch
125
+ - whether the operation produced the epoch secret
126
+
127
+ A direct-mode session never raises it.
122
128
 
123
129
  Do not set `protocolStrategy.sckaMode` when `protocol` is present. Use
124
130
  `protocol.braid` so the public product policy owns the direct-vs-Braid choice.
package/docs/RECIPES.md CHANGED
@@ -5,7 +5,7 @@
5
5
  > [Client Composition](./CLIENT_COMPOSITION.md) |
6
6
  > [Protocol Policy](./PROTOCOL_POLICY.md)
7
7
 
8
- Working shapes for the operations applications perform most often. Each example
8
+ Working shapes for the tasks applications do most often. Each example
9
9
  uses public exports only.
10
10
 
11
11
  ## Two local clients
@@ -90,8 +90,8 @@ bob decrypted: alice: hello
90
90
 
91
91
  The first message usually uses a `prekey_bundle` envelope because it establishes
92
92
  the session. Later messages on the same session use `ciphertext`. In both cases
93
- the relay sees encrypted envelope bytes; decrypted content is only surfaced to
94
- Bob through the `onMessageDecrypted` hook.
93
+ the relay sees encrypted envelope bytes. Bob receives decrypted content only
94
+ through the `onMessageDecrypted` hook.
95
95
 
96
96
  ## Production composition with Convex + Expo
97
97
 
@@ -389,5 +389,5 @@ await signal.media.cleanup(
389
389
  ```
390
390
 
391
391
  See the [encrypted media guide](../media/README.md) and
392
- [remote object storage](../remote/README.md) for the transfer and object-store
392
+ [remote object store](../remote/README.md) for the transfer and object-store
393
393
  contracts these examples compose.
package/docs/SECURITY.md CHANGED
@@ -28,15 +28,16 @@ compatibility boundary.
28
28
  - The SDK selects SESAME's per-user identity-key model and provisions that tuple
29
29
  unchanged across linked devices. Registration IDs, prekeys, and sessions are
30
30
  device-specific. Generic SESAME still supports both identity-key models.
31
- - Trust storage persists the tuple and trust metadata. Commitments are derived
32
- locally and a redundant supplied commitment must match before mutation.
31
+ - Trust storage persists the tuple and trust metadata. The SDK derives
32
+ commitments locally, and a redundant supplied commitment must match before
33
+ mutation.
33
34
  - First contact is `UNVERIFIED_TOFU`, not authenticated identity.
34
35
  - Replacing either component of a pinned tuple fails closed until rotation is
35
36
  explicitly accepted. A retired tuple cannot silently regain trust.
36
37
  - Authenticated safety-number comparison covers both peers' complete composite
37
38
  tuples and only promotes the exact current tuple to `VERIFIED`.
38
39
 
39
- The Ed25519 component performs ordinary RFC 8032 signatures. It does not
40
+ The Ed25519 component creates ordinary RFC 8032 signatures. It does not
40
41
  implement XEdDSA and cannot consume or produce XEdDSA identity signatures.
41
42
 
42
43
  ### PQXDH and ML-KEM-1024
@@ -46,9 +47,9 @@ implement XEdDSA and cannot consume or produce XEdDSA identity signatures.
46
47
  - Public keys and ciphertexts require exactly `0x0A || raw ML-KEM-1024 bytes`.
47
48
  Untagged values, the deployed Kyber1024 `0x08` tag, unknown tags, and wrong
48
49
  lengths fail before secret derivation or state commit.
49
- - Prekey signatures cover a domain-separated context containing the locally
50
- derived composite identity commitment, algorithm tag, key ID, and complete
51
- tagged public key.
50
+ - Prekey signatures cover a domain-separated context. That context contains the
51
+ locally derived composite identity commitment, algorithm tag, key ID, and
52
+ complete tagged public key.
52
53
  - `protocol.postQuantum: 'compatible'` is an explicit opt-in. It permits a
53
54
  classical session only when a peer advertises no PQ material. Malformed or
54
55
  failed PQ processing does not trigger fallback.
@@ -63,19 +64,20 @@ round-3 Kyber1024 tagged `0x08`.
63
64
  using ML-KEM-768 and bounded Reed-Solomon decoding.
64
65
  - HEK follows the ML-KEM Braid specification:
65
66
  `SHA3-256(ek_seed || ek_vector)`.
66
- - `KDF_OK` is applied once when raw ML-KEM output enters the epoch boundary.
67
- Braid output is already an epoch secret and is not derived a second time.
68
- - Malformed epoch secrets, roots, chain state, chunks, indexes, and wire values
69
- are validated before live-state commit.
67
+ - The SDK applies `KDF_OK` once when raw ML-KEM output enters the epoch
68
+ boundary. Braid output is already an epoch secret and is not derived a second
69
+ time.
70
+ - The SDK rejects malformed epoch secrets, roots, chain state, chunks, indexes,
71
+ and wire values before it commits live state.
70
72
  - Direct ML-KEM-768 SCKA remains an explicit SDK mode for product-reviewed
71
- constraints; it is not the default.
73
+ constraints. It is not the default.
72
74
 
73
75
  ## Forward and Post-Compromise Security
74
76
 
75
77
  The Double Ratchet derives a new message key for each chain step and advances
76
- chain state after successful use. Skipped receive keys are bounded and removed
77
- when consumed or expired. Fresh DH ratchet inputs provide break-in recovery once
78
- an uncompromised ratchet step is completed. SPQR adds periodic post-quantum
78
+ chain state after successful use. The SDK bounds skipped receive keys, and
79
+ removes each one after use or expiry. Fresh DH ratchet inputs provide break-in
80
+ recovery once an uncompromised ratchet step completes. SPQR adds post-quantum
79
81
  epoch material to the Triple Ratchet hybrid derivation.
80
82
 
81
83
  These properties depend on authenticated session establishment, uncompromised
@@ -86,7 +88,7 @@ source.
86
88
 
87
89
  Best-effort typed-array overwrites reduce the lifetime of some owned temporary
88
90
  buffers. They do not make old secrets physically unrecoverable from JavaScript
89
- memory; copies, strings, engine internals, CPU registers, and garbage-collected
91
+ memory. Copies, strings, engine internals, CPU registers, and garbage-collected
90
92
  heap pages remain outside the SDK's control.
91
93
 
92
94
  ## JavaScript Timing Boundary
@@ -95,10 +97,10 @@ Browser, Node, and Expo/React Native JavaScript engines provide no machine-level
95
97
  constant-time contract. The implementation uses best-effort source patterns on
96
98
  selected paths:
97
99
 
98
- - full-scan comparison for equal-length MACs and identity bytes;
99
- - fixed-work derivation of both decapsulation candidates before masked
100
- selection;
101
- - equal-work rejection padding on selected replay and authentication paths;
100
+ - full-scan comparison for equal-length MACs and identity bytes.
101
+ - fixed work on both decapsulation candidates, then a masked choice between
102
+ them.
103
+ - equal-work rejection padding on selected replay and authentication paths.
102
104
  - fixed-work rejection handling on selected authentication paths.
103
105
 
104
106
  These patterns do not prove timing equivalence. Secret-influenced remainder and
@@ -112,41 +114,50 @@ high-assurance co-resident timing adversary.
112
114
  `secureZeroBytes()` and related cleanup calls overwrite only the exact mutable
113
115
  typed array owned by the caller. They cannot guarantee erasure of:
114
116
 
115
- - earlier or implicit copies;
116
- - immutable Base64 or UTF-8 strings;
117
- - engine temporaries, registers, JIT artifacts, or garbage-collected pages;
117
+ - earlier or implicit copies.
118
+ - immutable Base64 or UTF-8 strings.
119
+ - engine temporaries, registers, JIT artifacts, or garbage-collected pages.
118
120
  - persisted copies held by an adapter or operating system.
119
121
 
120
- Applications should keep long-lived private material in the strongest
121
- platform-backed storage available, minimize plaintext/key lifetimes, avoid
122
- logging secrets, and treat a compromised JavaScript runtime as a key
123
- compromise. A qualified native/WASM/Rust/Swift backend is roadmap work when
124
- stronger timing or erasure assurance is required.
122
+ Applications should:
123
+
124
+ - keep long-lived private material in the strongest platform-backed storage
125
+ available.
126
+ - minimize plaintext/key lifetimes.
127
+ - avoid logging secrets.
128
+ - treat a compromised JavaScript runtime as a key compromise.
129
+
130
+ A qualified native/WASM/Rust/Swift backend is roadmap work when a deployment
131
+ requires stronger timing or erasure assurance.
125
132
 
126
133
  ## Storage Boundary
127
134
 
128
135
  Local adapters own identity keys, contact trust metadata, prekeys, session
129
136
  records, retry records, and group state. The package requires:
130
137
 
131
- - atomic composite-identity writes and explicit rotation acceptance;
132
- - current session-record format version 4;
133
- - rejection of stale-format writes before replacing current state;
134
- - removal or rejection of stale persisted session records on read;
135
- - no authoritative cached identity commitment;
138
+ - atomic composite-identity writes and explicit rotation acceptance.
139
+ - current session-record format version 4.
140
+ - that an adapter reject stale-format writes before it replaces current state.
141
+ - that an adapter remove or reject stale persisted session records on read.
142
+ - no authoritative cached identity commitment.
136
143
  - authenticated encryption for adapters that persist encrypted records.
137
144
 
138
- Adapter encryption does not compensate for XSS, malicious dependencies,
139
- compromised application code, a stolen unlocked device, or an attacker who also
140
- obtains the adapter encryption key. Browser IndexedDB and caller-provided React
141
- Native storage inherit their host application's security boundary.
145
+ Adapter encryption does not compensate for:
146
+
147
+ - XSS, malicious dependencies, or compromised application code.
148
+ - a stolen unlocked device.
149
+ - an attacker who also holds the adapter encryption key.
150
+
151
+ Browser IndexedDB and caller-provided React Native storage inherit their host
152
+ application's security boundary.
142
153
 
143
154
  Group sender key state never leaves the device. A sender key record holds the
144
- chain key every message key on that chain derives from and the sender's private
145
- signature key; together they are enough to read a sender's group messages and to
146
- forge new ones, so no adapter transmits them and no relay contract accepts them.
147
- The same rule covers the message keys held for out-of-order group messages.
148
- Local adapters bound that skipped-key store so a peer cannot grow it without
149
- limit by skipping ever further ahead.
155
+ chain key that every message key on that chain derives from, and the sender's
156
+ private signature key. Together they are enough to read a sender's group
157
+ messages and to forge new ones. No adapter transmits them, and no relay
158
+ contract accepts them. The same rule covers the message keys held for
159
+ out-of-order group messages. Local adapters bound that skipped-key store so a
160
+ peer cannot grow it without limit by skipping ever further ahead.
150
161
 
151
162
  Relay and remote object-store adapters receive public key material, routing
152
163
  metadata, and opaque ciphertext required by their contracts. TLS,
@@ -154,11 +165,12 @@ authorization, abuse controls, atomic prekey consumption, and access logging
154
165
  remain deployment responsibilities. The relay is not an identity trust anchor.
155
166
 
156
167
  Remote object-store upload requests use a retry identifier, not a storage key.
157
- Applications must scope that identifier to the authenticated principal and own
158
- the durable mapping from it to a canonical object identifier and a private
159
- provider key. Applications must also enforce object access, upload size, and
160
- encrypted-object content type on the backend. Presigned URLs are short-lived
161
- bearer credentials and must not be logged or exposed beyond the authorized
168
+ Applications must scope that identifier to the authenticated principal. They
169
+ must also own the durable mapping from it to a canonical object identifier and
170
+ a private provider key. Applications must also enforce object access, upload
171
+ size, and encrypted-object content type on the backend. Presigned URLs are
172
+ short-lived
173
+ bearer credentials. Never log one, and never expose one beyond the authorized
162
174
  operation.
163
175
 
164
176
  ## Resource and DoS Controls
@@ -170,7 +182,7 @@ chunk indexes, shard counts, and allocation before decoding. Retry processing
170
182
  limits attempts and requires an existing sent-message record unless a narrowly
171
183
  scoped lifecycle path explicitly bypasses message validation.
172
184
 
173
- These controls reduce amplification and unbounded allocation; they do not
185
+ These controls reduce amplification and unbounded allocation. They do not
174
186
  replace application-level request size limits, rate limiting, authentication,
175
187
  or transport abuse prevention.
176
188
 
@@ -178,25 +190,25 @@ or transport abuse prevention.
178
190
 
179
191
  In scope:
180
192
 
181
- - passive network observation;
182
- - active message tampering, replay, reordering, duplication, and truncation;
183
- - malicious or stale relay responses within the adapter contract;
184
- - identity component substitution after trust is pinned;
193
+ - passive network observation.
194
+ - active message tampering, replay, reordering, duplication, and truncation.
195
+ - malicious or stale relay responses within the adapter contract.
196
+ - identity component substitution after the SDK pins trust.
185
197
  - malformed prekeys, KEM keys/ciphertexts, protocol messages, restored state,
186
- Braid traces, and Reed-Solomon chunks;
187
- - loss and out-of-order delivery within configured protocol bounds;
198
+ Braid traces, and Reed-Solomon chunks.
199
+ - loss and out-of-order delivery within configured protocol bounds.
188
200
  - later compromise followed by an uncompromised ratchet recovery step.
189
201
 
190
202
  Out of scope or only partially mitigated:
191
203
 
192
- - compromised endpoints, JavaScript engines, dependencies, or build pipeline;
193
- - hostile same-process code and high-assurance local timing attackers;
194
- - guaranteed secret erasure from managed memory;
195
- - hardware, physical, speculative-execution, and microarchitectural attacks;
204
+ - compromised endpoints, JavaScript engines, dependencies, or build pipeline.
205
+ - hostile same-process code and high-assurance local timing attackers.
206
+ - guaranteed secret erasure from managed memory.
207
+ - hardware, physical, speculative-execution, and microarchitectural attacks.
196
208
  - traffic-analysis resistance beyond the metadata/padding behavior explicitly
197
- implemented;
209
+ implemented.
198
210
  - Signal Messenger interoperability outside the exact
199
- alignments stated in this security model;
211
+ alignments stated in this security model.
200
212
  - recovery of authenticity on unauthenticated first contact without an
201
213
  authenticated safety-number or configured trust mechanism.
202
214
 
@@ -26,7 +26,7 @@ const urlToken = bytesToUrlSafeBase64(bytes);
26
26
  const roundTrip = hexToBytes(bytesToHex(bytes));
27
27
  ```
28
28
 
29
- Treat encoded cryptographic values as opaque. Encoding changes representation;
30
- it does not encrypt, authenticate, or validate the meaning of the bytes.
29
+ Treat encoded cryptographic values as opaque. Encoding changes representation. It
30
+ does not encrypt, authenticate, or validate the meaning of the bytes.
31
31
 
32
32
  See the [API reference](../docs/api/namespaces/encoding/README.md).
package/files/README.md CHANGED
@@ -5,7 +5,7 @@ files and attachments.
5
5
 
6
6
  ## Why it exists
7
7
 
8
- Large payloads should not be embedded directly in Signal Protocol messages.
8
+ Do not embed large payloads directly in Signal Protocol messages.
9
9
  The application encrypts bytes locally, uploads only ciphertext, and sends the
10
10
  decryption key plus integrity metadata inside an end-to-end encrypted message.
11
11
 
package/groups/README.md CHANGED
@@ -42,11 +42,12 @@ The server must enforce authenticated access and version sequencing without
42
42
  receiving plaintext group attributes or group master keys. Membership removal
43
43
  must also invalidate or rotate group messaging state through the callbacks
44
44
  required by `GroupManagerOptions`. Every `getGroup()` response must include a
45
- baseline signature over the group ID, version, and exact encrypted-state bytes;
46
- the client verifies it before installing a first or post-revocation baseline.
45
+ baseline signature over the group ID, version, and exact encrypted-state bytes.
46
+ The client verifies that signature before installing a first or post-revocation
47
+ baseline.
47
48
 
48
49
  Deployments whose server does not yet sign group changes must opt in explicitly
49
- with `allowUnauthenticatedGroupHistory: true`; the SDK emits a security warning
50
+ with `allowUnauthenticatedGroupHistory: true`. The SDK emits a security warning
50
51
  because that mode has no authenticated group history.
51
52
 
52
53
  See the [API reference](../docs/api/README.md) and
package/hooks/README.md CHANGED
@@ -7,8 +7,8 @@ and single-flight helpers.
7
7
  ## Why it exists
8
8
 
9
9
  The core SDK is framework-neutral. React hooks live on a separate package
10
- subpath so non-React consumers do not load React and UI code can subscribe to
11
- SDK state without duplicating effect cleanup.
10
+ subpath. Non-React consumers therefore do not load React, and UI code can
11
+ subscribe to SDK state without duplicating effect cleanup.
12
12
 
13
13
  ## Usage
14
14
 
package/keys/README.md CHANGED
@@ -28,8 +28,8 @@ const signedPreKey = await generateEcSignedPreKey(identity);
28
28
  ```
29
29
 
30
30
  Ordinary application code usually lets `SignalProtocolClient` generate and
31
- persist this material. Direct key APIs are intended for adapter, provisioning,
32
- and advanced lifecycle integrations.
31
+ persist this material. Direct key APIs serve adapter, provisioning, and
32
+ advanced lifecycle integrations.
33
33
 
34
34
  ## Composite identity
35
35
 
@@ -47,7 +47,7 @@ The SDK provisions one tuple per `(userId, identityType)` across linked devices.
47
47
  ACI and PNI are independent identity types. Device registration IDs, prekeys,
48
48
  and sessions remain device-specific.
49
49
 
50
- The tuple is encoded as exactly 67 bytes:
50
+ The tuple encodes to exactly 67 bytes:
51
51
 
52
52
  ```text
53
53
  0x01 || 0x01 || X25519 public key || 0x02 || Ed25519 public key
@@ -72,7 +72,7 @@ not make this profile interoperable with XEdDSA identity signatures.
72
72
  ML-KEM-1024 public keys use the mandatory `0x0A || raw` representation: one tag
73
73
  byte plus 1,568 raw bytes. The corresponding serialized ciphertext has the same
74
74
  1,569-byte size. A value with the deployed round-3 Kyber1024 `0x08` tag is a
75
- different profile and is rejected.
75
+ different profile, and the SDK rejects it.
76
76
 
77
77
  Prekey signatures cover a domain-separated context, not only the raw key:
78
78
 
@@ -91,11 +91,12 @@ For ML-KEM-1024, `serialized public key` includes the `0x0A` tag.
91
91
  `PreKeyBundle` carries one composite identity and the device-specific material
92
92
  needed for X3DH/PQXDH session establishment:
93
93
 
94
- - registration ID and device ID;
95
- - composite identity tuple;
96
- - required signed EC prekey;
97
- - optional EC one-time prekey; and
98
- - either a one-time or last-resort signed ML-KEM-1024 prekey when PQXDH is used.
94
+ - registration ID and device ID.
95
+ - composite identity tuple.
96
+ - required signed EC prekey.
97
+ - optional EC one-time prekey.
98
+ - either a one-time or last-resort signed ML-KEM-1024 prekey when the session
99
+ uses PQXDH.
99
100
 
100
101
  Relay and storage adapters carry the same canonical tuple. Consumers must reject
101
102
  an identity mismatch before consuming a one-time prekey or committing a session.
@@ -103,11 +104,11 @@ an identity mismatch before consuming a one-time prekey or committing a session.
103
104
  ## Secret ownership
104
105
 
105
106
  Private keys are Base64 strings in the current public types and therefore cannot
106
- be reliably erased by the SDK. Temporary mutable byte arrays owned by generation
107
- or crypto functions are overwritten after use where practical, but JavaScript
108
- does not guarantee physical zeroization, freedom from copies, or hard
109
- constant-time execution. Long-lived keys should be held by the strongest
110
- platform-backed storage available to the application.
107
+ be reliably erased by the SDK. Generation and crypto functions overwrite their
108
+ temporary mutable byte arrays after use, where practical. JavaScript still does
109
+ not guarantee physical zeroization, freedom from copies, or hard constant-time
110
+ execution. The strongest platform-backed storage available to the application
111
+ should hold long-lived keys.
111
112
 
112
113
  ## Module boundaries
113
114