Add RPC command shard crawl (RIPD-1663)

src/ripple/rpc/handlers/CrawlShards.cpp

@@ -0,0 +1,83 @@
+//------------------------------------------------------------------------------
+/*
+    This file is part of rippled: https://github.com/ripple/rippled
+    Copyright (c) 2018 Ripple Labs Inc.
+
+    Permission to use, copy, modify, and/or distribute this software for any
+    purpose  with  or without fee is hereby granted, provided that the above
+    copyright notice and this permission notice appear in all copies.
+
+    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
+    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
+    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+*/
+//==============================================================================
+
+#include <ripple/app/main/Application.h>
+#include <ripple/net/RPCErr.h>
+#include <ripple/nodestore/DatabaseShard.h>
+#include <ripple/overlay/Overlay.h>
+#include <ripple/protocol/ErrorCodes.h>
+#include <ripple/protocol/JsonFields.h>
+#include <ripple/resource/Fees.h>
+#include <ripple/rpc/Context.h>
+
+namespace ripple {
+
+/** RPC command that reports stored shards by nodes.
+    {
+        // Determines if the result includes node public key.
+        // optional, default is false
+        pubkey: <bool>
+
+        // The maximum number of peer hops to attempt.
+        // optional, default is zero, maximum is 3
+        limit: <integer>
+    }
+*/
+Json::Value
+doCrawlShards(RPC::Context& context)
+{
+    if (context.role != Role::ADMIN)
+        return rpcError(rpcNO_PERMISSION);
+
+    std::uint32_t hops {0};
+    if (auto const& jv = context.params[jss::limit])
+    {
+        if (!(jv.isUInt() || (jv.isInt() && jv.asInt() >= 0)))
+        {
+            return RPC::expected_field_error(
+                jss::limit, "unsigned integer");
+        }
+
+        hops = std::min(jv.asUInt(), csHopLimit);
+    }
+
+    bool const pubKey {context.params.isMember(jss::public_key) &&
+        context.params[jss::public_key].asBool()};
+
+    // Collect shard info from peers connected to this server
+    Json::Value jvResult {context.app.overlay().crawlShards(pubKey, hops)};
+
+    // Collect shard info from this server
+    if (auto shardStore = context.app.getShardStore())
+    {
+        if (pubKey)
+            jvResult[jss::public_key] = toBase58(
+                TokenType::NodePublic, context.app.nodeIdentity().first);
+        jvResult[jss::complete_shards] = shardStore->getCompleteShards();
+    }
+
+    if (hops == 0)
+        context.loadType = Resource::feeMediumBurdenRPC;
+    else
+        context.loadType = Resource::feeHighBurdenRPC;
+
+    return jvResult;
+}
+
+} // ripple

src/ripple/rpc/handlers/Handlers.h

@@ -69,6 +69,7 @@ Json::Value doServerInfo            (RPC::Context&); // for humans
 Json::Value doServerState           (RPC::Context&); // for machines
 Json::Value doSign                  (RPC::Context&);
 Json::Value doSignFor               (RPC::Context&);
+Json::Value doCrawlShards           (RPC::Context&);
 Json::Value doStop                  (RPC::Context&);
 Json::Value doSubmit                (RPC::Context&);
 Json::Value doSubmitMultiSigned     (RPC::Context&);

src/ripple/rpc/impl/Handler.cpp

@@ -104,6 +104,7 @@ Handler const handlerArray[] {
     {   "submit_multisigned",   byRef (&doSubmitMultiSigned),   Role::USER,  NEEDS_CURRENT_LEDGER  },
     {   "server_info",          byRef (&doServerInfo),          Role::USER,  NO_CONDITION     },
     {   "server_state",         byRef (&doServerState),         Role::USER,  NO_CONDITION     },
+    {   "crawl_shards",         byRef (&doCrawlShards),         Role::ADMIN,  NO_CONDITION     },
     {   "stop",                 byRef (&doStop),                Role::ADMIN,   NO_CONDITION     },
     {   "transaction_entry",    byRef (&doTransactionEntry),    Role::USER,  NO_CONDITION  },
     {   "tx",                   byRef (&doTx),                  Role::USER,  NEEDS_NETWORK_CONNECTION  },