ox 0.6.12 → 0.7.1

package/index.ts

@@ -1559,6 +1559,54 @@ export * as Fee from './core/Fee.js'
  */
 export * as Json from './core/Json.js'
 
+/**
+ * Utilities & types for working with [Keystores](https://ethereum.org/en/developers/docs/data-structures-and-encoding/web3-secret-storage).
+ *
+ * @example
+ * ### Encrypting & Decrypting Private Keys
+ *
+ * Private keys can be encrypted into a JSON keystore using {@link ox#Keystore.(encrypt:function)} and decrypted using {@link ox#Keystore.(decrypt:function)}:
+ *
+ * ```ts twoslash
+ * import { Keystore, Secp256k1 } from 'ox'
+ *
+ * // Generate a random private key.
+ * const privateKey = Secp256k1.randomPrivateKey()
+ *
+ * // Derive a key from a password.
+ * const key = Keystore.pbkdf2({ password: 'testpassword' })
+ *
+ * // Encrypt the private key.
+ * const encrypted = await Keystore.encrypt(privateKey, key)
+ * // @log: {
+ * // @log:   "crypto": {
+ * // @log:     "cipher": "aes-128-ctr",
+ * // @log:     "ciphertext": "...",
+ * // @log:     "cipherparams": {
+ * // @log:       "iv": "...",
+ * // @log:     },
+ * // @log:     "kdf": "pbkdf2",
+ * // @log:     "kdfparams": {
+ * // @log:       "salt": "...",
+ * // @log:       "dklen": 32,
+ * // @log:       "prf": "hmac-sha256",
+ * // @log:       "c": 262144,
+ * // @log:     },
+ * // @log:     "mac": "...",
+ * // @log:   },
+ * // @log:   "id": "...",
+ * // @log:   "version": 3,
+ * // @log: }
+ *
+ * // Decrypt the private key.
+ * const decrypted = await Keystore.decrypt(encrypted, key)
+ * // @log: "0x..."
+ * ```
+ *
+ * @category Crypto
+ */
+export * as Keystore from './core/Keystore.js'
+
 /**
  * Utility functions for working with KZG Commitments.
  *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ox",
   "description": "Ethereum Standard Library",
-  "version": "0.6.12",
+  "version": "0.7.1",
   "main": "./_cjs/index.js",
   "module": "./_esm/index.js",
   "types": "./_types/index.d.ts",
@@ -16,6 +16,7 @@
   ],
   "dependencies": {
     "@adraffy/ens-normalize": "^1.10.1",
+    "@noble/ciphers": "^1.3.0",
     "@noble/curves": "^1.6.0",
     "@noble/hashes": "^1.5.0",
     "@scure/bip39": "^1.4.0",
@@ -212,6 +213,11 @@
       "import": "./_esm/core/Json.js",
       "default": "./_cjs/core/Json.js"
     },
+    "./Keystore": {
+      "types": "./_types/core/Keystore.d.ts",
+      "import": "./_esm/core/Keystore.js",
+      "default": "./_cjs/core/Keystore.js"
+    },
     "./Kzg": {
       "types": "./_types/core/Kzg.d.ts",
       "import": "./_esm/core/Kzg.js",

package/version.ts

@@ -1,2 +1,2 @@
 /** @internal */
-export const version = '0.6.12'
+export const version = '0.7.1'