Merge pull request #1195 from input-output-hk/stake_pool_get

Add stake pool details getter to REST

Author: NicolasDP

doc/jcli/rest.md

@@ -477,3 +477,36 @@ YAML printed on success
   # timestamp of last time gossip was received from node if ever (optional)
   lastGossipReceived: "2019-10-14T00:45:59.419496188+00:00"
 ```
+
+## Get stake pool details
+
+Fetches stake pool details
+
+```
+jcli rest v0 stake-pool get <pool-id> <options>
+```
+
+<pool-id> - hex-encoded pool ID
+
+The options are
+
+- -h <node_addr> - see [conventions](#conventions)
+- --debug - see [conventions](#conventions)
+- --output-format <format> - see [conventions](#conventions)
+
+YAML printed on success
+
+```yaml
+---
+tax:                        # pool reward
+  fixed: 5                  # what get subtracted as fixed value
+  ratio:                    # ratio of tax after fixed amount is subtracted. Expressed as numerator/denominator
+    numerator: 1
+    denominator: 10000
+  max: 100                  # limit of tax (optional)
+total_stake: 2000000000000  # total stake pool value
+# bech32-encoded stake pool KES key
+kesPublicKey: kes25519-12-pk1q7susucqwje0lpetqzjgzncgcrjzx7e2guh900qszdjskkeyqpusf3p39r
+# bech32-encoded stake pool VRF key
+vrfPublicKey: vrf_pk1rcm4qm3q9dtwq22x9a4avnan7a3k987zvepuxwekzj3uyu6a8v0s6sdy0l
+```

doc/openapi.yaml

@@ -662,6 +662,68 @@ paths:
                   type: string
                   pattern: '[0-9a-fA-F]+'
               example: [ "5cf03f333f37eb7b987dbc9017b8a928287a3d77d086cd93cd9ad05bcba7e60f" ]
+  /api/v0/stake_pool:
+    get:
+      description: Gets stake pool details
+      responses:
+        200:
+          description: Success
+          content:
+            application/json:
+              schema:
+                description: Stake pool details
+                type: object
+                required: [tax, total_stake, kesPublicKey, vrfPublicKey]
+                properies:
+                  tax:
+                    description: Pool reward
+                    type: object
+                    required: [fixed, ratio, max]
+                    properties:
+                      fixed:
+                        description: What get subtracted as fixed value
+                        type: integer
+                        minimum: 0
+                      ratio:
+                        description: Ratio of tax after fixed amount is subtracted. Expressed as numerator/denominator
+                        type: object
+                        required: [numerator, denominator]
+                        properties:
+                          numerator:
+                            type: integer
+                            minimum: 0
+                          denominator:
+                            type: integer
+                            minimum: 1
+                      max:
+                        description: Limit of tax
+                        type: integer
+                        minimum: 1
+                        nullable: true
+                  total_stake:
+                    description: Total stake pool value
+                    type: integer
+                    minimum: 0
+                  vrfPublicKey:
+                    description: Bech32-encoded stake pool KES key
+                    type: string
+                  vrfPublicKey:
+                    description: Bech32-encoded stake pool VRF key
+                    type: string
+              example: |
+                {
+                  "tax": {
+                    "fixed": 5,
+                    "ratio": {
+                      "numerator": 1
+                      "denominator": 10000,
+                    }
+                    "max": 100,
+                  },
+                  "total_stake": 2000000000000,
+                  "kesPublicKey": "kes25519-12-pk1q7susucqwje0lpetqzjgzncgcrjzx7e2guh900qszdjskkeyqpusf3p39r",
+                  "vrfPublicKey": "vrf_pk1rcm4qm3q9dtwq22x9a4avnan7a3k987zvepuxwekzj3uyu6a8v0s6sdy0l"
+                }
   /api/v0/stake:
     get:
       description: Gets stake distribution

jcli/src/jcli_app/rest/v0/mod.rs

@@ -7,6 +7,7 @@ mod node;
 mod settings;
 mod shutdown;
 mod stake;
+mod stake_pool;
 mod stake_pools;
 mod tip;
 mod utxo;
@@ -33,6 +34,8 @@ pub enum V0 {
     Settings(settings::Settings),
     /// Stake information
     Stake(stake::Stake),
+    /// Stake pool operations
+    StakePool(stake_pool::StakePool),
     /// Stake pools operations
     StakePools(stake_pools::StakePools),
     /// Shutdown node
@@ -54,6 +57,7 @@ impl V0 {
             V0::Node(node) => node.exec(),
             V0::Settings(settings) => settings.exec(),
             V0::Stake(stake) => stake.exec(),
+            V0::StakePool(stake_pool) => stake_pool.exec(),
             V0::StakePools(stake_pools) => stake_pools.exec(),
             V0::Shutdown(shutdown) => shutdown.exec(),
             V0::Tip(tip) => tip.exec(),

jcli/src/jcli_app/rest/v0/stake_pool/mod.rs

@@ -0,0 +1,40 @@
+use crate::jcli_app::rest::Error;
+use crate::jcli_app::utils::{DebugFlag, HostAddr, OutputFormat, RestApiSender};
+use structopt::StructOpt;
+
+#[derive(StructOpt)]
+#[structopt(rename_all = "kebab-case")]
+pub enum StakePool {
+    /// Get stake pool details
+    Get {
+        /// hex-encoded pool ID
+        pool_id: String,
+        #[structopt(flatten)]
+        addr: HostAddr,
+        #[structopt(flatten)]
+        debug: DebugFlag,
+        #[structopt(flatten)]
+        output_format: OutputFormat,
+    },
+}
+
+impl StakePool {
+    pub fn exec(self) -> Result<(), Error> {
+        let StakePool::Get {
+            pool_id,
+            addr,
+            debug,
+            output_format,
+        } = self;
+        let url = addr
+            .with_segments(&["v0", "stake_pool", &pool_id])?
+            .into_url();
+        let builder = reqwest::Client::new().get(url);
+        let response = RestApiSender::new(builder, &debug).send()?;
+        response.ok_response()?;
+        let status = response.body().json_value()?;
+        let formatted = output_format.format_json(status)?;
+        println!("{}", formatted);
+        Ok(())
+    }
+}

jormungandr/src/rest/v0/handlers.rs

@@ -14,6 +14,7 @@ use chain_impl_mockchain::value::{Value, ValueError};
 use chain_storage::error::Error as StorageError;
 
 use crate::blockchain::Ref;
+use crate::chain_crypto::bech32::Bech32;
 use crate::intercom::{self, NetworkMsg, TransactionMsg};
 use crate::secure::NodeSecret;
 use bytes::{Bytes, IntoBuf};
@@ -420,3 +421,38 @@ pub fn get_utxo(context: State<Context>, path_params: Path<(String, u8)>) -> Act
             })
         })
 }
+
+pub fn get_stake_pool(context: State<Context>, pool_id_hex: Path<String>) -> ActixFuture!() {
+    pool_id_hex
+        .parse()
+        .map_err(ErrorBadRequest)
+        .into_future()
+        .and_then(move |pool_id| {
+            chain_tip_fut(&context).and_then(move |blockchain_tip| {
+                let ledger = blockchain_tip.ledger();
+                let pool_reg = ledger.delegation().lookup(&pool_id).ok_or_else(|| {
+                    ErrorNotFound(format!("Stake pool '{}' not found", pool_id_hex))
+                })?;
+                let total_stake: u64 = ledger
+                    .get_stake_distribution()
+                    .to_pools
+                    .get(&pool_id)
+                    .map(|pool| pool.total.total_stake.into())
+                    .unwrap_or(0);
+                let tax = &pool_reg.rewards;
+                Ok(Json(json!({
+                    "kesPublicKey": pool_reg.keys.kes_public_key.to_bech32_str(),
+                    "vrfPublicKey": pool_reg.keys.vrf_public_key.to_bech32_str(),
+                    "total_stake": total_stake,
+                    "tax": {
+                        "fixed": tax.fixed.0,
+                        "ratio": {
+                            "numerator": tax.ratio.numerator,
+                            "denominator": tax.ratio.denominator,
+                        },
+                        "max": tax.max_limit,
+                    }
+                })))
+            })
+        })
+}

jormungandr/src/rest/v0/mod.rs

@@ -39,6 +39,9 @@ pub fn resources() -> Vec<(
         ("/stake_pools", &|r| {
             r.get().with_async(handlers::get_stake_pools)
         }),
+        ("/stake_pool/{pool_id}", &|r| {
+            r.get().with_async(handlers::get_stake_pool)
+        }),
         ("/shutdown", &|r| r.get().with(handlers::get_shutdown)),
         ("/message", &|r| r.post().with(handlers::post_message)),
         ("/node/stats", &|r| {