Adds env var support for setting cache size

Author: thewhaleking

async_substrate_interface/async_substrate.py

@@ -7,6 +7,7 @@
 import asyncio
 import inspect
 import logging
+import os
 import ssl
 import warnings
 from contextlib import suppress
@@ -42,7 +43,6 @@
     SubstrateRequestException,
     ExtrinsicNotFound,
     BlockNotFound,
-    MaxRetriesExceeded,
     StateDiscardedError,
 )
 from async_substrate_interface.protocols import Keypair
@@ -81,6 +81,10 @@
 logger = logging.getLogger("async_substrate_interface")
 raw_websocket_logger = logging.getLogger("raw_websocket")
 
+# env vars dictating the cache size of the cached methods
+SUBSTRATE_CACHE_METHOD_SIZE = int(os.getenv("SUBSTRATE_CACHE_METHOD_SIZE", "512"))
+SUBSTRATE_RUNTIME_CACHE_SIZE = int(os.getenv("SUBSTRATE_RUNTIME_CACHE_SIZE", "16"))
+
 
 class AsyncExtrinsicReceipt:
     """
@@ -2111,7 +2115,7 @@ async def get_metadata(self, block_hash=None) -> MetadataV15:
 
         return runtime.metadata_v15
 
-    @cached_fetcher(max_size=512)
+    @cached_fetcher(max_size=SUBSTRATE_CACHE_METHOD_SIZE)
     async def get_parent_block_hash(self, block_hash) -> str:
         """
         Retrieves the block hash of the parent of the given block hash
@@ -2166,7 +2170,7 @@ async def get_storage_by_key(self, block_hash: str, storage_key: str) -> Any:
                 "Unknown error occurred during retrieval of events"
             )
 
-    @cached_fetcher(max_size=16)
+    @cached_fetcher(max_size=SUBSTRATE_RUNTIME_CACHE_SIZE)
     async def get_block_runtime_info(self, block_hash: str) -> dict:
         """
         Retrieve the runtime info of given block_hash
@@ -2179,7 +2183,7 @@ async def _get_block_runtime_info(self, block_hash: str) -> dict:
         response = await self.rpc_request("state_getRuntimeVersion", [block_hash])
         return response.get("result")
 
-    @cached_fetcher(max_size=512)
+    @cached_fetcher(max_size=SUBSTRATE_CACHE_METHOD_SIZE)
     async def get_block_runtime_version_for(self, block_hash: str):
         """
         Retrieve the runtime version of the parent of a given block_hash
@@ -2494,7 +2498,7 @@ async def rpc_request(
         else:
             raise SubstrateRequestException(result[payload_id][0])
 
-    @cached_fetcher(max_size=512)
+    @cached_fetcher(max_size=SUBSTRATE_CACHE_METHOD_SIZE)
     async def get_block_hash(self, block_id: int) -> str:
         """
         Retrieves the hash of the specified block number
@@ -4022,19 +4026,19 @@ class DiskCachedAsyncSubstrateInterface(AsyncSubstrateInterface):
     Experimental new class that uses disk-caching in addition to memory-caching for the cached methods
     """
 
-    @async_sql_lru_cache(maxsize=512)
+    @async_sql_lru_cache(maxsize=SUBSTRATE_CACHE_METHOD_SIZE)
     async def get_parent_block_hash(self, block_hash):
         return await self._get_parent_block_hash(block_hash)
 
-    @async_sql_lru_cache(maxsize=16)
+    @async_sql_lru_cache(maxsize=SUBSTRATE_RUNTIME_CACHE_SIZE)
     async def get_block_runtime_info(self, block_hash: str) -> dict:
         return await self._get_block_runtime_info(block_hash)
 
-    @async_sql_lru_cache(maxsize=512)
+    @async_sql_lru_cache(maxsize=SUBSTRATE_CACHE_METHOD_SIZE)
     async def get_block_runtime_version_for(self, block_hash: str):
         return await self._get_block_runtime_version_for(block_hash)
 
-    @async_sql_lru_cache(maxsize=512)
+    @async_sql_lru_cache(maxsize=SUBSTRATE_CACHE_METHOD_SIZE)
     async def get_block_hash(self, block_id: int) -> str:
         return await self._get_block_hash(block_id)
 

async_substrate_interface/sync_substrate.py

@@ -1,5 +1,6 @@
 import functools
 import logging
+import os
 import socket
 from hashlib import blake2b
 from typing import Optional, Union, Callable, Any
@@ -55,6 +56,10 @@
 logger = logging.getLogger("async_substrate_interface")
 raw_websocket_logger = logging.getLogger("raw_websocket")
 
+# env vars dictating the cache size of the cached methods
+SUBSTRATE_CACHE_METHOD_SIZE = int(os.getenv("SUBSTRATE_CACHE_METHOD_SIZE", "512"))
+SUBSTRATE_RUNTIME_CACHE_SIZE = int(os.getenv("SUBSTRATE_RUNTIME_CACHE_SIZE", "16"))
+
 
 class ExtrinsicReceipt:
     """
@@ -1668,7 +1673,7 @@ def get_metadata(self, block_hash=None) -> MetadataV15:
 
         return runtime.metadata_v15
 
-    @functools.lru_cache(maxsize=512)
+    @functools.lru_cache(maxsize=SUBSTRATE_CACHE_METHOD_SIZE)
     def get_parent_block_hash(self, block_hash):
         block_header = self.rpc_request("chain_getHeader", [block_hash])
 
@@ -1708,7 +1713,7 @@ def get_storage_by_key(self, block_hash: str, storage_key: str) -> Any:
                 "Unknown error occurred during retrieval of events"
             )
 
-    @functools.lru_cache(maxsize=16)
+    @functools.lru_cache(maxsize=SUBSTRATE_RUNTIME_CACHE_SIZE)
     def get_block_runtime_info(self, block_hash: str) -> dict:
         """
         Retrieve the runtime info of given block_hash
@@ -1718,7 +1723,7 @@ def get_block_runtime_info(self, block_hash: str) -> dict:
 
     get_block_runtime_version = get_block_runtime_info
 
-    @functools.lru_cache(maxsize=512)
+    @functools.lru_cache(maxsize=SUBSTRATE_CACHE_METHOD_SIZE)
     def get_block_runtime_version_for(self, block_hash: str):
         """
         Retrieve the runtime version of the parent of a given block_hash
@@ -1959,7 +1964,7 @@ def _make_rpc_request(
 
         return request_manager.get_results()
 
-    @functools.lru_cache(maxsize=512)
+    @functools.lru_cache(maxsize=SUBSTRATE_CACHE_METHOD_SIZE)
     def supports_rpc_method(self, name: str) -> bool:
         """
         Check if substrate RPC supports given method
@@ -2036,7 +2041,7 @@ def rpc_request(
         else:
             raise SubstrateRequestException(result[payload_id][0])
 
-    @functools.lru_cache(maxsize=512)
+    @functools.lru_cache(maxsize=SUBSTRATE_CACHE_METHOD_SIZE)
     def get_block_hash(self, block_id: int) -> str:
         return self.rpc_request("chain_getBlockHash", [block_id])["result"]