ARCHIVE/xahaud
3
0
Fork 0
mirror of https://github.com/Xahau/xahaud.git synced 2025-11-20 10:35:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

APIv2(gateway_balances, channel_authorize): update errors (#4618)

Browse Source 
gateway_balances
* When `account` does not exist in the ledger, return `actNotFound`
  * (Previously, a normal response was returned)
  * Fix #4290
* When required field(s) are missing, return `invalidParams`
  * (Previously, `invalidHotWallet` was incorrectly returned)
  * Fix #4548

channel_authorize
* When the specified `key_type` is invalid, return `badKeyType`
  * (Previously, `invalidParams` was returned)
  * Fix #4289

Since these are breaking changes, they apply only to API version 2.

Supersedes #4577
This commit is contained in:
Peter Chen
2023-09-21 16:33:24 -04:00
committed by tequ
parent 53cdb040cf
commit 07dda63bd5
8 changed files with 225 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/ripple/protocol/ErrorCodes.h
View File

@@ -79,7 +79,7 @@ enum error_code_i {
// unused 27,
// unused 28,
rpcTXN_NOT_FOUND = 29,
// unused 30,
rpcINVALID_HOTWALLET = 30,
// Malformed command
rpcINVALID_PARAMS = 31,

1
src/ripple/protocol/impl/ErrorCodes.cpp
View File

@@ -76,6 +76,7 @@ constexpr static ErrorInfo unorderedErrorInfos[]{
{rpcINTERNAL, "internal", "Internal error.", 500},
{rpcINVALID_LGR_RANGE, "invalidLgrRange", "Ledger range is invalid.", 400},
{rpcINVALID_PARAMS, "invalidParams", "Invalid parameters.", 400},
{rpcINVALID_HOTWALLET, "invalidHotWallet", "Invalid hotwallet.", 400},
{rpcISSUE_MALFORMED, "issueMalformed", "Issue is malformed.", 400},
{rpcJSON_RPC, "json_rpc", "JSON-RPC transport error.", 500},
{rpcLGR_IDXS_INVALID, "lgrIdxsInvalid", "Ledger indexes invalid.", 400},

19
src/ripple/rpc/handlers/GatewayBalances.cpp
View File

@@ -78,6 +78,12 @@ doGatewayBalances(RPC::JsonContext& context)
result[jss::account] = toBase58(accountID);
if (context.apiVersion > 1u && !ledger->exists(keylet::account(accountID)))
{
RPC::inject_error(rpcACT_NOT_FOUND, result);
return result;
}
// Parse the specified hotwallet(s), if any
std::set<AccountID> hotWallets;
@@ -116,7 +122,18 @@ doGatewayBalances(RPC::JsonContext& context)
if (!valid)
{
result[jss::error] = "invalidHotWallet";
// The documentation states that invalidParams is used when
// One or more fields are specified incorrectly.
// invalidHotwallet should be used when the account exists, but does
// not have currency issued by the account from the request.
if (context.apiVersion < 2u)
{
RPC::inject_error(rpcINVALID_HOTWALLET, result);
}
else
{
RPC::inject_error(rpcINVALID_PARAMS, result);
}
return result;
}
}

3
src/ripple/rpc/handlers/PayChanClaim.cpp
View File

@@ -55,7 +55,8 @@ doChannelAuthorize(RPC::JsonContext& context)
return RPC::missing_field_error(jss::secret);
Json::Value result;
auto const [pk, sk] = RPC::keypairForSignature(params, result);
auto const [pk, sk] =
RPC::keypairForSignature(params, result, context.apiVersion);
if (RPC::contains_error(result))
return result;

8
src/ripple/rpc/impl/RPCHelpers.cpp
View File

@@ -972,7 +972,10 @@ getSeedFromRPC(Json::Value const& params, Json::Value& error)
}
std::pair<PublicKey, SecretKey>
keypairForSignature(Json::Value const& params, Json::Value& error)
keypairForSignature(
Json::Value const& params,
Json::Value& error,
unsigned int apiVersion)
{
bool const has_key_type = params.isMember(jss::key_type);
@@ -1026,6 +1029,9 @@ keypairForSignature(Json::Value const& params, Json::Value& error)
if (!keyType)
{
if (apiVersion > 1u)
error = RPC::make_error(rpcBAD_KEY_TYPE);
else
error = RPC::invalid_field_error(jss::key_type);
return {};
}

9
src/ripple/rpc/impl/RPCHelpers.h
View File

@@ -225,9 +225,6 @@ getSeedFromRPC(Json::Value const& params, Json::Value& error);
std::optional<Seed>
parseRippleLibSeed(Json::Value const& params);
std::pair<PublicKey, SecretKey>
keypairForSignature(Json::Value const& params, Json::Value& error);
/**
* API version numbers used in API version 1
*/
@@ -312,6 +309,12 @@ getAPIVersionNumber(const Json::Value& value, bool betaEnabled);
std::variant<std::shared_ptr<Ledger const>, Json::Value>
getLedgerByContext(RPC::JsonContext& context);
std::pair<PublicKey, SecretKey>
keypairForSignature(
Json::Value const& params,
Json::Value& error,
uint apiVersion = apiVersionIfUnspecified);
} // namespace RPC
} // namespace ripple

46
src/test/app/PayChan_test.cpp
View File

@@ -24,9 +24,9 @@
#include <ripple/protocol/PayChan.h>
#include <ripple/protocol/TxFlags.h>
#include <ripple/protocol/jss.h>
#include <test/jtx.h>
#include <ripple/rpc/impl/RPCHelpers.h>
#include <chrono>
#include <test/jtx.h>
namespace ripple {
namespace test {
@@ -1144,6 +1144,47 @@ struct PayChan_test : public beast::unit_test::suite
bob.human());
}
void
testAccountChannelAuthorize(FeatureBitset features)
{
using namespace jtx;
using namespace std::literals::chrono_literals;
Env env{*this, features};
auto const alice = Account("alice");
auto const bob = Account("bob");
auto const charlie = Account("charlie", KeyType::ed25519);
env.fund(XRP(10000), alice, bob, charlie);
auto const pk = alice.pk();
auto const settleDelay = 3600s;
auto const channelFunds = XRP(1000);
auto const chan1Str = to_string(channel(alice, bob, env.seq(alice)));
env(create(alice, bob, channelFunds, settleDelay, pk));
env.close();
Json::Value args{Json::objectValue};
args[jss::channel_id] = chan1Str;
args[jss::key_type] = "ed255191";
args[jss::seed] = "snHq1rzQoN2qiUkC3XF5RyxBzUtN";
args[jss::amount] = 51110000;
// test for all api versions
for (auto apiVersion = RPC::apiMinimumSupportedVersion;
apiVersion <= RPC::apiBetaVersion;
++apiVersion)
{
testcase(
"PayChan Channel_Auth RPC Api " + std::to_string(apiVersion));
args[jss::api_version] = apiVersion;
auto const rs = env.rpc(
"json",
"channel_authorize",
args.toStyledString())[jss::result];
auto const error = apiVersion < 2u ? "invalidParams" : "badKeyType";
BEAST_EXPECT(rs[jss::error] == error);
}
}
void
testAuthVerifyRPC(FeatureBitset features)
{
@@ -5509,6 +5550,7 @@ struct PayChan_test : public beast::unit_test::suite
testAccountChannelsRPC(features);
testAccountChannelsRPCMarkers(features);
testAccountChannelsRPCSenderOnly(features);
testAccountChannelAuthorize(features);
testAuthVerifyRPC(features);
testOptionalFields(features);
testMalformedPK(features);

48
src/test/rpc/GatewayBalances_test.cpp
View File

@@ -18,6 +18,7 @@
#include <ripple/beast/unit_test.h>
#include <ripple/protocol/Feature.h>
#include <ripple/protocol/jss.h>
#include <ripple/rpc/impl/RPCHelpers.h>
#include <test/jtx.h>
#include <test/jtx/WSClient.h>
@@ -34,6 +35,7 @@ public:
using namespace jtx;
Env env(*this, features);
{
// Gateway account and assets
Account const alice{"alice"};
env.fund(XRP(10000), "alice");
@@ -88,7 +90,8 @@ public:
if (wsc->version() == 2)
{
expect(jv.isMember(jss::jsonrpc) && jv[jss::jsonrpc] == "2.0");
expect(jv.isMember(jss::ripplerpc) && jv[jss::ripplerpc] == "2.0");
expect(
jv.isMember(jss::ripplerpc) && jv[jss::ripplerpc] == "2.0");
expect(jv.isMember(jss::id) && jv[jss::id] == 5);
}
@@ -147,6 +150,42 @@ public:
expect(obligations["USD"] == "50");
}
}
}
void
testGWBApiVersions(FeatureBitset features)
{
using namespace std::chrono_literals;
using namespace jtx;
Env env(*this, features);
// Gateway account and assets
Account const alice{"alice"};
env.fund(XRP(10000), alice);
Account const hw{"hw"};
env.fund(XRP(10000), hw);
env.close();
auto wsc = makeWSClient(env.app().config());
Json::Value qry2;
qry2[jss::account] = alice.human();
qry2[jss::hotwallet] = "asdf";
for (auto apiVersion = RPC::apiMinimumSupportedVersion;
apiVersion <= RPC::apiBetaVersion;
++apiVersion)
{
qry2[jss::api_version] = apiVersion;
auto jv = wsc->invoke("gateway_balances", qry2);
expect(jv[jss::status] == "error");
auto response = jv[jss::result];
auto const error =
apiVersion < 2u ? "invalidHotWallet" : "invalidParams";
BEAST_EXPECT(response[jss::error] == error);
}
}
void
testGWBOverflow()
@@ -207,8 +246,11 @@ public:
{
using namespace jtx;
auto const sa = supported_amendments();
testGWB(sa - featureFlowCross);
testGWB(sa);
for (auto feature : {sa - featureFlowCross, sa})
{
testGWB(feature);
testGWBApiVersions(feature);
}
testGWBOverflow();
}