diff --git a/prdoc/pr_7885.prdoc b/prdoc/pr_7885.prdoc new file mode 100644 index 0000000000000000000000000000000000000000..bfea03d6041a2f154fb5d1d1ea495f2f1ba6176f --- /dev/null +++ b/prdoc/pr_7885.prdoc @@ -0,0 +1,11 @@ +title: Rename archive call method result to value + +doc: + - audience: [Node Dev, Node Operator] + description: | + Previously, the method result was encoded to a json containing a "result" field. However, + the spec specifies a "value" field. This aims to rectify that. + +crates: + - name: sc-rpc-spec-v2 + bump: major diff --git a/substrate/client/rpc-spec-v2/src/lib.rs b/substrate/client/rpc-spec-v2/src/lib.rs index fa822fd446bae50c542418b2ea824355af9679ca..7bda8370eb5d438fa3989b081f8e709e92da852b 100644 --- a/substrate/client/rpc-spec-v2/src/lib.rs +++ b/substrate/client/rpc-spec-v2/src/lib.rs @@ -49,7 +49,7 @@ pub enum MethodResult { impl MethodResult { /// Constructs a successful result. pub fn ok(result: impl Into<String>) -> MethodResult { - MethodResult::Ok(MethodResultOk { success: true, result: result.into() }) + MethodResult::Ok(MethodResultOk { success: true, value: result.into() }) } /// Constructs an error result. @@ -65,7 +65,7 @@ pub struct MethodResultOk { /// Method was successful. success: bool, /// The result of the method. - pub result: String, + pub value: String, } /// The error result of an RPC method. @@ -92,7 +92,7 @@ mod tests { let ok = MethodResult::ok("hello"); let ser = serde_json::to_string(&ok).unwrap(); - let exp = r#"{"success":true,"result":"hello"}"#; + let exp = r#"{"success":true,"value":"hello"}"#; assert_eq!(ser, exp); let ok_dec: MethodResult = serde_json::from_str(exp).unwrap();