From be3f8ffd4970130721705e29f4207deb7a9cfa64 Mon Sep 17 00:00:00 2001 From: Gav Wood Date: Wed, 23 Dec 2015 11:10:34 +0000 Subject: [PATCH] Additional docs. --- src/spec.rs | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/spec.rs b/src/spec.rs index d47a2a3c2..9a7a56e23 100644 --- a/src/spec.rs +++ b/src/spec.rs @@ -67,9 +67,6 @@ pub struct Spec { } impl Spec { -// pub fn new(engine_name: String, engine_params: HashMap, builtins: HashMap, genesis: Genesis) { -// } - /// Convert this object into a boxed Engine of the right underlying type. // TODO avoid this hard-coded nastiness - use dynamic-linked plugin framework instead. pub fn to_engine(self) -> Result, EthcoreError> { @@ -125,7 +122,7 @@ impl Spec { impl Spec { - /// Loads genesis block from json file + /// Loads a chain-specification from a json data structure pub fn from_json(json: Json) -> Spec { // once we commit ourselves to some json parsing library (serde?) // move it to proper data structure @@ -157,7 +154,7 @@ impl Spec { Spec { engine_name: json["engineName"].as_string().unwrap().to_string(), - engine_params: json_to_rlp(&json["engineParams"]), + engine_params: json_to_rlp(&json["params"]), builtins: builtins, parent_hash: H256::from_str(&json["parentHash"].as_string().unwrap()[2..]).unwrap(), author: Address::from_str(&json["coinbase"].as_string().unwrap()[2..]).unwrap(), @@ -173,6 +170,7 @@ impl Spec { } } + /// Creates the Olympic network chain spec. pub fn olympic() -> Spec { Spec { engine_name: "Ethash".to_string(), @@ -210,6 +208,7 @@ impl Spec { } } + /// Creates the Frontier network chain spec. pub fn frontier() -> Spec { Spec { engine_name: "Ethash".to_string(), @@ -247,6 +246,7 @@ impl Spec { } } + /// Creates the Morden network chain spec. pub fn morden() -> Spec { Spec { engine_name: "Ethash".to_string(),