state_getKeys - JSON-RPC Method

Description

Returns storage keys that match a given prefix. This JSON-RPC method is useful for discovering all storage entries under a specific module or querying multiple related storage items. Be cautious with broad prefixes as they may return large result sets.

Request Example

{
  "jsonrpc": "2.0",
  "method": "state_getKeys",
  "params": [
    "0x26aa394eea5630e07c48ae0c9558cef7b99d880ec681799c0cf30e8886371da9"
  ],
  "id": 1
}

Code Examples

Common Storage Prefixes

Batch Query Example

// Efficiently query multiple storage values
async function batchQueryStorage(api, keys) {
  // Get all values in a single call
  const values = await api.rpc.state.queryStorageAt(keys);
  
  const results = {};
  keys.forEach((key, index) => {
    results[key.toString()] = values[index];
  });
  
  return results;
}

// Example usage
const keys = await getStorageKeys(accountPrefix);
const values = await batchQueryStorage(api, keys.slice(0, 10));
console.log('Batch query results:', values);

Use Cases

1. Account Discovery: Find all accounts with balances
2. Validator Enumeration: List all validators in the network
3. Storage Analysis: Analyze storage usage by module
4. Migration Scripts: Iterate over storage for upgrades
5. Indexing: Build indexes of on-chain data

Notes

• Large prefixes may return many keys - use pagination when available
• Keys are returned in lexicographical order
• The prefix must be hex-encoded
• Consider using state_getKeysPaged for large datasets
• Storage keys include both the storage prefix and the key data

Related Methods

• state_getKeysPaged - Get keys with pagination
• state_getStorage - Get storage value
• state_getMetadata - Get metadata to decode keys