Add offchain_localStorageClear RPC method (#6070)

polkadot-js · Jan 24, 2025 · 97fe4ea · 97fe4ea
1 parent beca93e
commit 97fe4ea
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 0 deletions.
diff --git a/packages/rpc-augment/src/augment/jsonrpc.ts b/packages/rpc-augment/src/augment/jsonrpc.ts
@@ -404,6 +404,10 @@ declare module '@polkadot/rpc-core/types/jsonrpc' {
       version: AugmentedRpc<() => Observable<Text>>;
     };
     offchain: {
+      /**
+       * Clear offchain local storage under given key and prefix
+       **/
+      localStorageClear: AugmentedRpc<(kind: StorageKind | 'PERSISTENT' | 'LOCAL' | number | Uint8Array, key: Bytes | string | Uint8Array) => Observable<Null>>;
       /**
        * Get offchain local storage under given key and prefix
        **/

diff --git a/packages/types-support/src/metadata/v14/polkadot-rpc.ts b/packages/types-support/src/metadata/v14/polkadot-rpc.ts
@@ -67,6 +67,7 @@ export default {
     "mmr_root",
     "mmr_verifyProof",
     "mmr_verifyProofStateless",
+    "offchain_localStorageClear",
     "offchain_localStorageGet",
     "offchain_localStorageSet",
     "payment_queryFeeDetails",

diff --git a/packages/types-support/src/metadata/v14/substrate-rpc.ts b/packages/types-support/src/metadata/v14/substrate-rpc.ts
@@ -68,6 +68,7 @@ export default {
     "mmr_root",
     "mmr_verifyProof",
     "mmr_verifyProofStateless",
+    "offchain_localStorageClear",
     "offchain_localStorageGet",
     "offchain_localStorageSet",
     "payment_queryFeeDetails",

diff --git a/packages/types-support/src/metadata/v15/polkadot-rpc.ts b/packages/types-support/src/metadata/v15/polkadot-rpc.ts
@@ -74,6 +74,7 @@ export default {
     "mmr_root",
     "mmr_verifyProof",
     "mmr_verifyProofStateless",
+    "offchain_localStorageClear",
     "offchain_localStorageGet",
     "offchain_localStorageSet",
     "payment_queryFeeDetails",

diff --git a/packages/types-support/src/metadata/v15/substrate-rpc.ts b/packages/types-support/src/metadata/v15/substrate-rpc.ts
@@ -68,6 +68,7 @@ export default {
     "mmr_root",
     "mmr_verifyProof",
     "mmr_verifyProofStateless",
+    "offchain_localStorageClear",
     "offchain_localStorageGet",
     "offchain_localStorageSet",
     "payment_queryFeeDetails",

diff --git a/packages/types/src/interfaces/offchain/rpc.ts b/packages/types/src/interfaces/offchain/rpc.ts
@@ -4,6 +4,21 @@
 import type { DefinitionsRpc } from '../../types/index.js';
 
 export const rpc: DefinitionsRpc = {
+  localStorageClear: {
+    description: 'Clear offchain local storage under given key and prefix',
+    isUnsafe: true,
+    params: [
+      {
+        name: 'kind',
+        type: 'StorageKind'
+      },
+      {
+        name: 'key',
+        type: 'Bytes'
+      }
+    ],
+    type: 'Null'
+  },
   localStorageGet: {
     description: 'Get offchain local storage under given key and prefix',
     isUnsafe: true,