@metamask-previews/storage-service 1.0.0-preview-e493d3e8 → 1.0.0-preview-81c9cf83

package/CHANGELOG.md

@@ -10,13 +10,5 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Initial release of `@metamask/storage-service`
-- Add `StorageService` class for platform-agnostic storage
-- Add `StorageAdapter` interface for platform-specific implementations
-- Add `InMemoryStorageAdapter` as default storage (for tests/dev)
-- Add namespace-based key isolation
-- Add support for `setItem`, `getItem`, `removeItem`, `getAllKeys`, and `clear` operations
-- Add messenger integration for cross-controller communication
-- Add `STORAGE_KEY_PREFIX` constant for consistent key prefixing across adapters
-- Add comprehensive test coverage
 
 [Unreleased]: https://github.com/MetaMask/core/

package/LICENSE

@@ -1,20 +1,6 @@
-MIT License
+This project is licensed under either of
 
-Copyright (c) 2025 MetaMask
+ * MIT license ([LICENSE.MIT](LICENSE.MIT))
+ * Apache License, Version 2.0 ([LICENSE.APACHE2](LICENSE.APACHE2))
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+at your option. 

package/LICENSE.APACHE2

@@ -0,0 +1,201 @@
+ 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 2025 MetaMask
+
+   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.

package/LICENSE.MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,22 +2,18 @@
 
 A platform-agnostic service for storing large, infrequently accessed controller data outside of memory.
 
-## Problem
-
-Controllers store large, infrequently-accessed data in Redux state, causing:
-- **State bloat**: 10.79 MB total, with 9.94 MB (92%) in just 2 controllers
-- **Slow app startup**: Parsing 10.79 MB on every launch
-- **High memory usage**: All data loaded, even if rarely accessed
-- **Slow persist operations**: Up to 5.95 MB written per controller change
-
-**Production measurements** (MetaMask Mobile):
-- SnapController sourceCode: 5.95 MB (55% of state)
-- TokenListController cache: 3.99 MB (37% of state)
-- **Combined**: 9.94 MB in just 2 controllers
+## When to Use
 
-## Solution
+✅ **Use StorageService for:**
+- Large data (> 100 KB)
+- Infrequently accessed data
+- Data that doesn't need to be in Redux state
+- Examples: Snap source code, cached API responses
 
-`StorageService` provides a messenger-based API for controllers to store large data on disk instead of in memory. Data is loaded lazily only when needed.
+❌ **Don't use for:**
+- Frequently accessed data (use controller state)
+- Small data (< 10 KB - overhead not worth it)
+- Data needed for UI rendering
 
 ## Installation
 
@@ -27,298 +23,77 @@ or
 
 `npm install @metamask/storage-service`
 
-## Architecture
-
-The service is **platform-agnostic** and accepts an optional `StorageAdapter`:
-
-- **With Adapter** (Production): Client provides platform-specific storage
-  - Mobile: FilesystemStorage adapter → Data persists
-  - Extension: IndexedDB adapter → Data persists
-  
-- **Without Adapter** (Default): Uses in-memory storage
-  - Testing: No setup needed, isolated tests
-  - Development: Quick start, no config
-  - ⚠️ Data lost on restart
-
-## Events
-
-StorageService publishes events when data changes, enabling reactive patterns:
-
-**Events published**:
-- `StorageService:itemSet:{namespace}` - When data is stored
-  - Payload: `[value, key]`
-- `StorageService:itemRemoved:{namespace}` - When data is removed
-  - Payload: `[key]`
-
-**Example - Subscribe to changes**:
-```typescript
-// In another controller
-this.messenger.subscribe(
-  'StorageService:itemSet:ControllerA',
-  (value, key) => {
-    console.log(`ControllerA stored data: ${key}`);
-    // React to changes without coupling
-  },
-);
-```
-
 ## Usage
 
-### Via Messenger (Recommended)
-
-The service is designed to be used via a messenger, allowing controllers to access storage without direct dependencies.
-
-#### 1. Controller Setup
+### Controller Setup
 
 ```typescript
 import type {
   StorageServiceSetItemAction,
   StorageServiceGetItemAction,
-  StorageServiceRemoveItemAction,
 } from '@metamask/storage-service';
 
 // Grant access to storage actions
 type AllowedActions =
   | StorageServiceSetItemAction
-  | StorageServiceGetItemAction
-  | StorageServiceRemoveItemAction;
+  | StorageServiceGetItemAction;
 
-type SnapControllerMessenger = Messenger<
-  'SnapController',
-  SnapControllerActions | AllowedActions,
-  SnapControllerEvents
->;
-
-class SnapController extends BaseController<
-  'SnapController',
-  SnapControllerState,
-  SnapControllerMessenger
-> {
-  async storeSnapSourceCode(snapId: string, sourceCode: string) {
-    // Store 3.86 MB of source code on disk, not in state
+class MyController extends BaseController<...> {
+  async storeData(id: string, data: string) {
     await this.messenger.call(
       'StorageService:setItem',
-      'SnapController',
-      `${snapId}:sourceCode`,
-      sourceCode,
+      'MyController',
+      `${id}:data`,
+      data,
     );
   }
 
-  async getSnapSourceCode(snapId: string): Promise<string | null> {
-    // Load source code only when snap needs to execute
+  async getData(id: string): Promise<unknown> {
     return await this.messenger.call(
       'StorageService:getItem',
-      'SnapController',
-      `${snapId}:sourceCode`,
+      'MyController',
+      `${id}:data`,
     );
   }
 }
 ```
 
-#### 2. Service Initialization (Client)
+### Service Initialization
 
-**Mobile:**
+The service accepts an optional `StorageAdapter` for platform-specific storage:
 
 ```typescript
-import {
-  StorageService,
-  type StorageAdapter,
-  STORAGE_KEY_PREFIX,
-} from '@metamask/storage-service';
-import FilesystemStorage from 'redux-persist-filesystem-storage';
+import { StorageService, type StorageAdapter } from '@metamask/storage-service';
 
-// Adapters handle key building and serialization
-const mobileStorageAdapter: StorageAdapter = {
-  async getItem(namespace: string, key: string) {
-    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-    const serialized = await FilesystemStorage.getItem(fullKey);
-    if (!serialized) return null;
-    const wrapper = JSON.parse(serialized);
-    return wrapper.data;
-  },
-  async setItem(namespace: string, key: string, value: unknown) {
-    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-    const wrapper = { timestamp: Date.now(), data: value };
-    await FilesystemStorage.setItem(fullKey, JSON.stringify(wrapper), Device.isIos());
-  },
-  async removeItem(namespace: string, key: string) {
-    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-    await FilesystemStorage.removeItem(fullKey);
-  },
-  async getAllKeys(namespace: string) {
-    const prefix = `${STORAGE_KEY_PREFIX}${namespace}:`;
-    const allKeys = await FilesystemStorage.getAllKeys();
-    return allKeys
-      .filter((k: string) => k.startsWith(prefix))
-      .map((k: string) => k.slice(prefix.length));
-  },
-  async clear(namespace: string) {
-    const keys = await this.getAllKeys(namespace);
-    await Promise.all(keys.map((k) => this.removeItem(namespace, k)));
-  },
-};
-
-// Initialize service
-const service = new StorageService({
-  messenger: storageServiceMessenger,
-  storage: mobileStorageAdapter,
-});
-```
-
-**Extension:**
-
-```typescript
-import {
-  StorageService,
-  type StorageAdapter,
-  STORAGE_KEY_PREFIX,
-} from '@metamask/storage-service';
-
-// Adapters handle key building and serialization
-const extensionStorageAdapter: StorageAdapter = {
-  async getItem(namespace: string, key: string) {
-    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-    const db = await openDB();
-    const serialized = await db.get('storage-service', fullKey);
-    if (!serialized) return null;
-    const wrapper = JSON.parse(serialized);
-    return wrapper.data;
-  },
-  async setItem(namespace: string, key: string, value: unknown) {
-    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-    const wrapper = { timestamp: Date.now(), data: value };
-    const db = await openDB();
-    await db.put('storage-service', JSON.stringify(wrapper), fullKey);
-  },
-  async removeItem(namespace: string, key: string) {
-    const fullKey = `${STORAGE_KEY_PREFIX}${namespace}:${key}`;
-    const db = await openDB();
-    await db.delete('storage-service', fullKey);
-  },
-  async getAllKeys(namespace: string) {
-    const prefix = `${STORAGE_KEY_PREFIX}${namespace}:`;
-    const db = await openDB();
-    const allKeys = await db.getAllKeys('storage-service');
-    return allKeys
-      .filter((k: string) => k.startsWith(prefix))
-      .map((k: string) => k.slice(prefix.length));
-  },
-  async clear(namespace: string) {
-    const keys = await this.getAllKeys(namespace);
-    await Promise.all(keys.map((k) => this.removeItem(namespace, k)));
-  },
-};
-
-// Initialize service
+// Production: Provide a platform-specific adapter
 const service = new StorageService({
   messenger: storageServiceMessenger,
-  storage: extensionStorageAdapter,
+  storage: myPlatformAdapter, // FilesystemStorage, IndexedDB, etc.
 });
-```
 
-**Testing:**
-
-```typescript
-import { StorageService } from '@metamask/storage-service';
-
-// No storage adapter needed - uses in-memory by default
-const service = new StorageService({
+// Testing: Uses in-memory storage by default
+const testService = new StorageService({
   messenger: testMessenger,
-  // storage: undefined, // Optional - defaults to InMemoryStorageAdapter
+  // No adapter needed - data isolated per test
 });
-
-// Works immediately, data isolated per test
-await service.setItem('TestController', 'key', 'value');
 ```
 
-#### 3. Delegate Actions to Controllers
-
-```typescript
-rootMessenger.delegate({
-  actions: [
-    'StorageService:setItem',
-    'StorageService:getItem',
-    'StorageService:removeItem',
-  ],
-  messenger: snapControllerMessenger,
-});
-```
+### Events
 
-### Direct Usage
-
-You can also use the service directly without a messenger:
-
-```typescript
-import { StorageService, InMemoryStorageAdapter } from '@metamask/storage-service';
-
-const service = new StorageService({
-  messenger: myMessenger,
-  storage: new InMemoryStorageAdapter(),
-});
-
-await service.setItem('MyController', 'myKey', { data: 'value' });
-const data = await service.getItem('MyController', 'myKey');
-```
-
-## API
-
-### `StorageService`
-
-#### `setItem<T>(namespace: string, key: string, value: T): Promise<void>`
-
-Store data in storage.
-
-- `namespace` - Controller namespace (e.g., 'SnapController')
-- `key` - Storage key (e.g., 'npm:@metamask/bitcoin-wallet-snap:sourceCode')
-- `value` - Data to store (will be JSON stringified)
-
-```typescript
-await service.setItem('SnapController', 'snap-id:sourceCode', sourceCode);
-```
-
-#### `getItem<T>(namespace: string, key: string): Promise<T | null>`
-
-Retrieve data from storage.
-
-- `namespace` - Controller namespace
-- `key` - Storage key
-- **Returns**: Parsed data or null if not found
-
-```typescript
-const sourceCode = await service.getItem('SnapController', 'snap-id:sourceCode');
-```
-
-#### `removeItem(namespace: string, key: string): Promise<void>`
-
-Remove data from storage.
-
-```typescript
-await service.removeItem('SnapController', 'snap-id:sourceCode');
-```
-
-#### `getAllKeys(namespace: string): Promise<string[]>`
-
-Get all keys for a namespace (without prefix).
-
-```typescript
-const keys = await service.getAllKeys('SnapController');
-// Returns: ['snap-id-1:sourceCode', 'snap-id-2:sourceCode', ...]
-```
-
-#### `clear(namespace: string): Promise<void>`
-
-Clear all data for a namespace.
+Subscribe to storage changes:
 
 ```typescript
-await service.clear('SnapController');
+this.messenger.subscribe(
+  'StorageService:itemSet:MyController',
+  (value, key) => {
+    console.log(`Data stored: ${key}`);
+  },
+);
 ```
 
 ## StorageAdapter Interface
 
-Implement this interface to provide platform-specific storage. Adapters are responsible for:
-- Building the full storage key (e.g., `storageService:namespace:key`)
-- Wrapping data with metadata (timestamp) before serialization
-- Serializing/deserializing data (JSON.stringify/parse)
+Implement this interface to provide platform-specific storage:
 
 ```typescript
 export type StorageAdapter = {
@@ -330,48 +105,11 @@ export type StorageAdapter = {
 };
 ```
 
-## When to Use
-
-✅ **Use StorageService for:**
-- Large data (> 100 KB)
-- Infrequently accessed data
-- Data that doesn't need to be in Redux state
-- Examples: Snap source code (6 MB), cached API responses (4 MB)
-
-❌ **Don't use for:**
-- Frequently accessed data (use controller state)
-- Small data (< 10 KB - overhead not worth it)
-- Data needed for UI rendering
-- Critical data that must be in Redux
-
-## Storage Key Format
-
-Adapters build keys with prefix: `storageService:{namespace}:{key}`
-
-Examples:
-- `storageService:SnapController:npm:@metamask/bitcoin-wallet-snap:sourceCode`
-- `storageService:TokenListController:cache:0x1`
-
-This provides:
-- Namespace isolation (prevents collisions)
-- Easy debugging (clear key format)
-- Scoped clearing (clear removes all keys for controller)
-
-## Real-World Impact
-
-**Production measurements** (MetaMask Mobile):
-
-**Per-controller**:
-- SnapController: 5.95 MB sourceCode → 166 KB metadata (97% reduction)
-- TokenListController: 3.99 MB cache → 61 bytes metadata (99.9% reduction)
-
-**Combined**:
-- Total state: 10.79 MB → 0.85 MB (**92% reduction**)
-- App startup: 92% less data to parse
-- Memory freed: 9.94 MB
-- Disk I/O: Up to 9.94 MB less per persist operation
+Adapters are responsible for:
+- Building the full storage key (e.g., `storageService:namespace:key`)
+- Wrapping data with metadata before serialization
+- Serializing/deserializing data
 
 ## Contributing
 
 This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).
-