Stabilize V2 archive RPC methods

Author: jsdw

substrate/client/rpc-spec-v2/src/archive/api.rs

@@ -36,8 +36,8 @@ pub trait ArchiveApi<Hash> {
 	/// # Unstable
 	///
 	/// This method is unstable and subject to change in the future.
-	#[method(name = "archive_unstable_body")]
-	fn archive_unstable_body(&self, hash: Hash) -> RpcResult<Option<Vec<String>>>;
+	#[method(name = "archive_v1_body")]
+	fn archive_v1_body(&self, hash: Hash) -> RpcResult<Option<Vec<String>>>;
 
 	/// Get the chain's genesis hash.
 	///
@@ -46,8 +46,8 @@ pub trait ArchiveApi<Hash> {
 	/// # Unstable
 	///
 	/// This method is unstable and subject to change in the future.
-	#[method(name = "archive_unstable_genesisHash")]
-	fn archive_unstable_genesis_hash(&self) -> RpcResult<String>;
+	#[method(name = "archive_v1_genesisHash")]
+	fn archive_v1_genesis_hash(&self) -> RpcResult<String>;
 
 	/// Get the block's header.
 	///
@@ -57,8 +57,8 @@ pub trait ArchiveApi<Hash> {
 	/// # Unstable
 	///
 	/// This method is unstable and subject to change in the future.
-	#[method(name = "archive_unstable_header")]
-	fn archive_unstable_header(&self, hash: Hash) -> RpcResult<Option<String>>;
+	#[method(name = "archive_v1_header")]
+	fn archive_v1_header(&self, hash: Hash) -> RpcResult<Option<String>>;
 
 	/// Get the height of the current finalized block.
 	///
@@ -67,8 +67,8 @@ pub trait ArchiveApi<Hash> {
 	/// # Unstable
 	///
 	/// This method is unstable and subject to change in the future.
-	#[method(name = "archive_unstable_finalizedHeight")]
-	fn archive_unstable_finalized_height(&self) -> RpcResult<u64>;
+	#[method(name = "archive_v1_finalizedHeight")]
+	fn archive_v1_finalized_height(&self) -> RpcResult<u64>;
 
 	/// Get the hashes of blocks from the given height.
 	///
@@ -78,16 +78,16 @@ pub trait ArchiveApi<Hash> {
 	/// # Unstable
 	///
 	/// This method is unstable and subject to change in the future.
-	#[method(name = "archive_unstable_hashByHeight")]
-	fn archive_unstable_hash_by_height(&self, height: u64) -> RpcResult<Vec<String>>;
+	#[method(name = "archive_v1_hashByHeight")]
+	fn archive_v1_hash_by_height(&self, height: u64) -> RpcResult<Vec<String>>;
 
 	/// Call into the Runtime API at a specified block's state.
 	///
 	/// # Unstable
 	///
 	/// This method is unstable and subject to change in the future.
-	#[method(name = "archive_unstable_call")]
-	fn archive_unstable_call(
+	#[method(name = "archive_v1_call")]
+	fn archive_v1_call(
 		&self,
 		hash: Hash,
 		function: String,
@@ -100,11 +100,11 @@ pub trait ArchiveApi<Hash> {
 	///
 	/// This method is unstable and subject to change in the future.
 	#[subscription(
-		name = "archive_unstable_storage" => "archive_unstable_storageEvent",
-		unsubscribe = "archive_unstable_stopStorage",
+		name = "archive_v1_storage" => "archive_v1_storageEvent",
+		unsubscribe = "archive_v1_stopStorage",
 		item = ArchiveStorageEvent,
 	)]
-	fn archive_unstable_storage(
+	fn archive_v1_storage(
 		&self,
 		hash: Hash,
 		items: Vec<StorageQuery<String>>,
@@ -117,11 +117,11 @@ pub trait ArchiveApi<Hash> {
 	///
 	/// This method is unstable and can change in minor or patch releases.
 	#[subscription(
-		name = "archive_unstable_storageDiff" => "archive_unstable_storageDiffEvent",
-		unsubscribe = "archive_unstable_storageDiff_stopStorageDiff",
+		name = "archive_v1_storageDiff" => "archive_v1_storageDiffEvent",
+		unsubscribe = "archive_v1_storageDiff_stopStorageDiff",
 		item = ArchiveStorageDiffEvent,
 	)]
-	fn archive_unstable_storage_diff(
+	fn archive_v1_storage_diff(
 		&self,
 		hash: Hash,
 		items: Vec<ArchiveStorageDiffItem<String>>,

substrate/client/rpc-spec-v2/src/archive/archive.rs

@@ -117,7 +117,7 @@ where
 		+ StorageProvider<Block, BE>
 		+ 'static,
 {
-	fn archive_unstable_body(&self, hash: Block::Hash) -> RpcResult<Option<Vec<String>>> {
+	fn archive_v1_body(&self, hash: Block::Hash) -> RpcResult<Option<Vec<String>>> {
 		let Ok(Some(signed_block)) = self.client.block(hash) else { return Ok(None) };
 
 		let extrinsics = signed_block
@@ -130,21 +130,21 @@ where
 		Ok(Some(extrinsics))
 	}
 
-	fn archive_unstable_genesis_hash(&self) -> RpcResult<String> {
+	fn archive_v1_genesis_hash(&self) -> RpcResult<String> {
 		Ok(self.genesis_hash.clone())
 	}
 
-	fn archive_unstable_header(&self, hash: Block::Hash) -> RpcResult<Option<String>> {
+	fn archive_v1_header(&self, hash: Block::Hash) -> RpcResult<Option<String>> {
 		let Ok(Some(header)) = self.client.header(hash) else { return Ok(None) };
 
 		Ok(Some(hex_string(&header.encode())))
 	}
 
-	fn archive_unstable_finalized_height(&self) -> RpcResult<u64> {
+	fn archive_v1_finalized_height(&self) -> RpcResult<u64> {
 		Ok(self.client.info().finalized_number.saturated_into())
 	}
 
-	fn archive_unstable_hash_by_height(&self, height: u64) -> RpcResult<Vec<String>> {
+	fn archive_v1_hash_by_height(&self, height: u64) -> RpcResult<Vec<String>> {
 		let height: NumberFor<Block> = U256::from(height)
 			.try_into()
 			.map_err(|_| ArchiveError::InvalidParam(format!("Invalid block height: {}", height)))?;
@@ -195,7 +195,7 @@ where
 		Ok(result)
 	}
 
-	fn archive_unstable_call(
+	fn archive_v1_call(
 		&self,
 		hash: Block::Hash,
 		function: String,
@@ -214,7 +214,7 @@ where
 		})
 	}
 
-	fn archive_unstable_storage(
+	fn archive_v1_storage(
 		&self,
 		pending: PendingSubscriptionSink,
 		hash: Block::Hash,
@@ -265,7 +265,7 @@ where
 		self.executor.spawn("substrate-rpc-subscription", Some("rpc"), fut.boxed());
 	}
 
-	fn archive_unstable_storage_diff(
+	fn archive_v1_storage_diff(
 		&self,
 		pending: PendingSubscriptionSink,
 		hash: Block::Hash,

substrate/client/rpc-spec-v2/src/archive/tests.rs

@@ -95,7 +95,7 @@ async fn archive_genesis() {
 	let (_client, api) = setup_api();
 
 	let genesis: String =
-		api.call("archive_unstable_genesisHash", EmptyParams::new()).await.unwrap();
+		api.call("archive_v1_genesisHash", EmptyParams::new()).await.unwrap();
 	assert_eq!(genesis, hex_string(&CHAIN_GENESIS));
 }
 
@@ -105,7 +105,7 @@ async fn archive_body() {
 
 	// Invalid block hash.
 	let invalid_hash = hex_string(&INVALID_HASH);
-	let res: Option<Vec<String>> = api.call("archive_unstable_body", [invalid_hash]).await.unwrap();
+	let res: Option<Vec<String>> = api.call("archive_v1_body", [invalid_hash]).await.unwrap();
 	assert!(res.is_none());
 
 	// Import a new block with an extrinsic.
@@ -129,7 +129,7 @@ async fn archive_body() {
 
 	let expected_tx = hex_string(&block.extrinsics[0].encode());
 
-	let body: Vec<String> = api.call("archive_unstable_body", [block_hash]).await.unwrap();
+	let body: Vec<String> = api.call("archive_v1_body", [block_hash]).await.unwrap();
 	assert_eq!(vec![expected_tx], body);
 }
 
@@ -139,7 +139,7 @@ async fn archive_header() {
 
 	// Invalid block hash.
 	let invalid_hash = hex_string(&INVALID_HASH);
-	let res: Option<String> = api.call("archive_unstable_header", [invalid_hash]).await.unwrap();
+	let res: Option<String> = api.call("archive_v1_header", [invalid_hash]).await.unwrap();
 	assert!(res.is_none());
 
 	// Import a new block with an extrinsic.
@@ -161,7 +161,7 @@ async fn archive_header() {
 	let block_hash = format!("{:?}", block.header.hash());
 	client.import(BlockOrigin::Own, block.clone()).await.unwrap();
 
-	let header: String = api.call("archive_unstable_header", [block_hash]).await.unwrap();
+	let header: String = api.call("archive_v1_header", [block_hash]).await.unwrap();
 	let bytes = array_bytes::hex2bytes(&header).unwrap();
 	let header: Header = Decode::decode(&mut &bytes[..]).unwrap();
 	assert_eq!(header, block.header);
@@ -174,7 +174,7 @@ async fn archive_finalized_height() {
 	let client_height: u32 = client.info().finalized_number.saturated_into();
 
 	let height: u32 =
-		api.call("archive_unstable_finalizedHeight", EmptyParams::new()).await.unwrap();
+		api.call("archive_v1_finalizedHeight", EmptyParams::new()).await.unwrap();
 
 	assert_eq!(client_height, height);
 }
@@ -184,7 +184,7 @@ async fn archive_hash_by_height() {
 	let (client, api) = setup_api();
 
 	// Genesis height.
-	let hashes: Vec<String> = api.call("archive_unstable_hashByHeight", [0]).await.unwrap();
+	let hashes: Vec<String> = api.call("archive_v1_hashByHeight", [0]).await.unwrap();
 	assert_eq!(hashes, vec![format!("{:?}", client.genesis_hash())]);
 
 	// Block tree:
@@ -260,28 +260,28 @@ async fn archive_hash_by_height() {
 	client.import(BlockOrigin::Own, block_4.clone()).await.unwrap();
 
 	// Check finalized height.
-	let hashes: Vec<String> = api.call("archive_unstable_hashByHeight", [1]).await.unwrap();
+	let hashes: Vec<String> = api.call("archive_v1_hashByHeight", [1]).await.unwrap();
 	assert_eq!(hashes, vec![format!("{:?}", finalized_hash)]);
 
 	// Test nonfinalized heights.
 	// Height N must include block 1.
 	let mut height = block_1.header.number;
-	let hashes: Vec<String> = api.call("archive_unstable_hashByHeight", [height]).await.unwrap();
+	let hashes: Vec<String> = api.call("archive_v1_hashByHeight", [height]).await.unwrap();
 	assert_eq!(hashes, vec![format!("{:?}", block_1_hash)]);
 
 	// Height (N + 1) must include block 2 and 4.
 	height += 1;
-	let hashes: Vec<String> = api.call("archive_unstable_hashByHeight", [height]).await.unwrap();
+	let hashes: Vec<String> = api.call("archive_v1_hashByHeight", [height]).await.unwrap();
 	assert_eq!(hashes, vec![format!("{:?}", block_4_hash), format!("{:?}", block_2_hash)]);
 
 	// Height (N + 2) must include block 3.
 	height += 1;
-	let hashes: Vec<String> = api.call("archive_unstable_hashByHeight", [height]).await.unwrap();
+	let hashes: Vec<String> = api.call("archive_v1_hashByHeight", [height]).await.unwrap();
 	assert_eq!(hashes, vec![format!("{:?}", block_3_hash)]);
 
 	// Height (N + 3) has no blocks.
 	height += 1;
-	let hashes: Vec<String> = api.call("archive_unstable_hashByHeight", [height]).await.unwrap();
+	let hashes: Vec<String> = api.call("archive_v1_hashByHeight", [height]).await.unwrap();
 	assert!(hashes.is_empty());
 }
 
@@ -293,7 +293,7 @@ async fn archive_call() {
 	// Invalid parameter (non-hex).
 	let err = api
 		.call::<_, serde_json::Value>(
-			"archive_unstable_call",
+			"archive_v1_call",
 			[&invalid_hash, "BabeApi_current_epoch", "0x00X"],
 		)
 		.await
@@ -303,7 +303,7 @@ async fn archive_call() {
 	// Pass an invalid parameters that cannot be decode.
 	let err = api
 		.call::<_, serde_json::Value>(
-			"archive_unstable_call",
+			"archive_v1_call",
 			// 0x0 is invalid.
 			[&invalid_hash, "BabeApi_current_epoch", "0x0"],
 		)
@@ -313,7 +313,7 @@ async fn archive_call() {
 
 	// Invalid hash.
 	let result: MethodResult = api
-		.call("archive_unstable_call", [&invalid_hash, "BabeApi_current_epoch", "0x00"])
+		.call("archive_v1_call", [&invalid_hash, "BabeApi_current_epoch", "0x00"])
 		.await
 		.unwrap();
 	assert_matches!(result, MethodResult::Err(_));
@@ -335,7 +335,7 @@ async fn archive_call() {
 	let call_parameters = hex_string(&alice_id.encode());
 	let result: MethodResult = api
 		.call(
-			"archive_unstable_call",
+			"archive_v1_call",
 			[&format!("{:?}", block_1_hash), "AccountNonceApi_account_nonce", &call_parameters],
 		)
 		.await
@@ -368,7 +368,7 @@ async fn archive_storage_hashes_values() {
 	];
 
 	let mut sub = api
-		.subscribe_unbounded("archive_unstable_storage", rpc_params![&block_hash, items.clone()])
+		.subscribe_unbounded("archive_v1_storage", rpc_params![&block_hash, items.clone()])
 		.await
 		.unwrap();
 
@@ -393,7 +393,7 @@ async fn archive_storage_hashes_values() {
 	let expected_value = hex_string(&VALUE);
 
 	let mut sub = api
-		.subscribe_unbounded("archive_unstable_storage", rpc_params![&block_hash, items])
+		.subscribe_unbounded("archive_v1_storage", rpc_params![&block_hash, items])
 		.await
 		.unwrap();
 
@@ -456,7 +456,7 @@ async fn archive_storage_hashes_values_child_trie() {
 	];
 	let mut sub = api
 		.subscribe_unbounded(
-			"archive_unstable_storage",
+			"archive_v1_storage",
 			rpc_params![&genesis_hash, items, &child_info],
 		)
 		.await
@@ -502,7 +502,7 @@ async fn archive_storage_closest_merkle_value() {
 	) -> HashMap<String, String> {
 		let mut sub = api
 			.subscribe_unbounded(
-				"archive_unstable_storage",
+				"archive_v1_storage",
 				rpc_params![
 					&block_hash,
 					vec![
@@ -664,7 +664,7 @@ async fn archive_storage_iterations() {
 	let invalid_hash = hex_string(&INVALID_HASH);
 	let mut sub = api
 		.subscribe_unbounded(
-			"archive_unstable_storage",
+			"archive_v1_storage",
 			rpc_params![
 				&invalid_hash,
 				vec![StorageQuery {
@@ -684,7 +684,7 @@ async fn archive_storage_iterations() {
 	// Valid call with storage at the key.
 	let mut sub = api
 		.subscribe_unbounded(
-			"archive_unstable_storage",
+			"archive_v1_storage",
 			rpc_params![
 				&block_hash,
 				vec![StorageQuery {
@@ -791,7 +791,7 @@ async fn archive_storage_diff_main_trie() {
 	];
 	let mut sub = api
 		.subscribe_unbounded(
-			"archive_unstable_storageDiff",
+			"archive_v1_storageDiff",
 			rpc_params![&block_hash, items.clone(), &prev_hash],
 		)
 		.await
@@ -894,7 +894,7 @@ async fn archive_storage_diff_no_changes() {
 	}];
 	let mut sub = api
 		.subscribe_unbounded(
-			"archive_unstable_storageDiff",
+			"archive_v1_storageDiff",
 			rpc_params![&block_hash, items.clone(), &prev_hash],
 		)
 		.await
@@ -949,7 +949,7 @@ async fn archive_storage_diff_deleted_changes() {
 
 	let mut sub = api
 		.subscribe_unbounded(
-			"archive_unstable_storageDiff",
+			"archive_v1_storageDiff",
 			rpc_params![&block_hash, items.clone(), &prev_hash],
 		)
 		.await
@@ -979,7 +979,7 @@ async fn archive_storage_diff_invalid_params() {
 	let items: Vec<ArchiveStorageDiffItem<String>> = Vec::new();
 	let err = api
 		.subscribe_unbounded(
-			"archive_unstable_storageDiff",
+			"archive_v1_storageDiff",
 			rpc_params!["123", items.clone(), &invalid_hash],
 		)
 		.await
@@ -992,7 +992,7 @@ async fn archive_storage_diff_invalid_params() {
 	let items: Vec<ArchiveStorageDiffItem<String>> = Vec::new();
 	let mut sub = api
 		.subscribe_unbounded(
-			"archive_unstable_storageDiff",
+			"archive_v1_storageDiff",
 			rpc_params![&invalid_hash, items.clone(), &invalid_hash],
 		)
 		.await