Add rpc to get Sprout to Sapling migration status
This commit is contained in:
parent
52cfa9c1ee
commit
6e82d72852
|
@ -11,12 +11,36 @@ from test_framework.util import assert_equal, assert_true, get_coinbase_address,
|
|||
initialize_chain_clean, start_nodes, wait_and_assert_operationid_status, \
|
||||
wait_and_assert_operationid_status_result
|
||||
|
||||
SAPLING_ADDR = 'zregtestsapling1ssqj3f3majnl270985gqcdqedd9t4nlttjqskccwevj2v20sc25deqspv3masufnwcdy67cydyy'
|
||||
SAPLING_KEY = 'secret-extended-key-regtest1qv62zt2fqyqqpqrh2qzc08h7gncf4447jh9kvnnnhjg959fkwt7mhw9j8e9at7attx8z6u3953u86vcnsujdc2ckdlcmztjt44x3uxpah5mxtncxd0mqcnz9eq8rghh5m4j44ep5d9702sdvvwawqassulktfegrcp4twxgqdxx4eww3lau0mywuaeztpla2cmvagr5nj98elt45zh6fjznadl6wz52n2uyhdwcm2wlsu8fnxstrk6s4t55t8dy6jkgx5g0cwpchh5qffp8x5'
|
||||
|
||||
|
||||
def check_migration_status(
|
||||
node,
|
||||
enabled,
|
||||
non_zero_unmigrated_amount,
|
||||
non_zero_unfinalized_migrated_amount,
|
||||
non_zero_finalized_migrated_amount,
|
||||
finalized_migration_transactions,
|
||||
len_migration_txids
|
||||
):
|
||||
status = node.z_getmigrationstatus()
|
||||
assert_equal(enabled, status['enabled'])
|
||||
assert_equal(SAPLING_ADDR, status['destination_address'])
|
||||
assert_equal(non_zero_unmigrated_amount, Decimal(status['unmigrated_amount']) > Decimal('0.00'))
|
||||
assert_equal(non_zero_unfinalized_migrated_amount, Decimal(status['unfinalized_migrated_amount']) > Decimal('0'))
|
||||
assert_equal(non_zero_finalized_migrated_amount, Decimal(status['finalized_migrated_amount']) > Decimal('0'))
|
||||
assert_equal(finalized_migration_transactions, status['finalized_migration_transactions'])
|
||||
assert_equal(len_migration_txids, len(status['migration_txids']))
|
||||
|
||||
|
||||
class SproutSaplingMigration(BitcoinTestFramework):
|
||||
def setup_nodes(self):
|
||||
return start_nodes(4, self.options.tmpdir, [[
|
||||
'-nuparams=5ba81b19:100', # Overwinter
|
||||
'-nuparams=76b809bb:100', # Sapling
|
||||
'-migration',
|
||||
'-migrationdestaddress=' + SAPLING_ADDR
|
||||
]] * 4)
|
||||
|
||||
def setup_chain(self):
|
||||
|
@ -24,6 +48,10 @@ class SproutSaplingMigration(BitcoinTestFramework):
|
|||
initialize_chain_clean(self.options.tmpdir, 4)
|
||||
|
||||
def run_test(self):
|
||||
check_migration_status(self.nodes[0], True, False, False, False, 0, 0)
|
||||
self.nodes[0].z_setmigration(False)
|
||||
check_migration_status(self.nodes[0], False, False, False, False, 0, 0)
|
||||
|
||||
print "Mining blocks..."
|
||||
self.nodes[0].generate(101)
|
||||
self.sync_all()
|
||||
|
@ -31,7 +59,8 @@ class SproutSaplingMigration(BitcoinTestFramework):
|
|||
# Send some ZEC to a Sprout address
|
||||
tAddr = get_coinbase_address(self.nodes[0])
|
||||
sproutAddr = self.nodes[0].z_getnewaddress('sprout')
|
||||
saplingAddr = self.nodes[0].z_getnewaddress('sapling')
|
||||
# Import a previously generated key to test '-migrationdestaddress'
|
||||
self.nodes[0].z_importkey(SAPLING_KEY)
|
||||
|
||||
opid = self.nodes[0].z_sendmany(tAddr, [{"address": sproutAddr, "amount": Decimal('10')}], 1, 0)
|
||||
wait_and_assert_operationid_status(self.nodes[0], opid)
|
||||
|
@ -39,7 +68,7 @@ class SproutSaplingMigration(BitcoinTestFramework):
|
|||
self.sync_all()
|
||||
|
||||
assert_equal(self.nodes[0].z_getbalance(sproutAddr), Decimal('10'))
|
||||
assert_equal(self.nodes[0].z_getbalance(saplingAddr), Decimal('0'))
|
||||
assert_equal(self.nodes[0].z_getbalance(SAPLING_ADDR), Decimal('0'))
|
||||
|
||||
# Migrate
|
||||
self.nodes[0].z_setmigration(True)
|
||||
|
@ -49,6 +78,7 @@ class SproutSaplingMigration(BitcoinTestFramework):
|
|||
|
||||
# At 494 we should have no async operations
|
||||
assert_equal(0, len(self.nodes[0].z_getoperationstatus()), "num async operations at 494")
|
||||
check_migration_status(self.nodes[0], True, True, False, False, 0, 0)
|
||||
|
||||
self.nodes[0].generate(1)
|
||||
self.sync_all()
|
||||
|
@ -74,7 +104,7 @@ class SproutSaplingMigration(BitcoinTestFramework):
|
|||
# At 498 the mempool will be empty and no funds will have moved
|
||||
assert_equal(0, len(self.nodes[0].getrawmempool()), "mempool size at 498")
|
||||
assert_equal(self.nodes[0].z_getbalance(sproutAddr), Decimal('10'))
|
||||
assert_equal(self.nodes[0].z_getbalance(saplingAddr), Decimal('0'))
|
||||
assert_equal(self.nodes[0].z_getbalance(SAPLING_ADDR), Decimal('0'))
|
||||
|
||||
self.nodes[0].generate(1)
|
||||
self.sync_all()
|
||||
|
@ -82,20 +112,26 @@ class SproutSaplingMigration(BitcoinTestFramework):
|
|||
# At 499 there will be a transaction in the mempool and the note will be locked
|
||||
assert_equal(1, len(self.nodes[0].getrawmempool()), "mempool size at 499")
|
||||
assert_equal(self.nodes[0].z_getbalance(sproutAddr), Decimal('0'))
|
||||
assert_equal(self.nodes[0].z_getbalance(saplingAddr), Decimal('0'))
|
||||
assert_true(self.nodes[0].z_getbalance(saplingAddr, 0) > Decimal('0'), "Unconfirmed sapling")
|
||||
assert_equal(self.nodes[0].z_getbalance(SAPLING_ADDR), Decimal('0'))
|
||||
assert_true(self.nodes[0].z_getbalance(SAPLING_ADDR, 0) > Decimal('0'), "Unconfirmed sapling")
|
||||
|
||||
self.nodes[0].generate(1)
|
||||
self.sync_all()
|
||||
|
||||
# At 500 funds will have moved
|
||||
sprout_balance = self.nodes[0].z_getbalance(sproutAddr)
|
||||
sapling_balance = self.nodes[0].z_getbalance(saplingAddr)
|
||||
sapling_balance = self.nodes[0].z_getbalance(SAPLING_ADDR)
|
||||
print "sprout balance: {}, sapling balance: {}".format(sprout_balance, sapling_balance)
|
||||
assert_true(sprout_balance < Decimal('10'), "Should have less Sprout funds")
|
||||
assert_true(sapling_balance > Decimal('0'), "Should have more Sapling funds")
|
||||
assert_true(sprout_balance + sapling_balance, Decimal('9.9999'))
|
||||
|
||||
check_migration_status(self.nodes[0], True, True, True, False, 0, 1)
|
||||
# At 510 the transactions will be considered 'finalized'
|
||||
self.nodes[0].generate(10)
|
||||
self.sync_all()
|
||||
check_migration_status(self.nodes[0], True, True, False, True, 1, 1)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
SproutSaplingMigration().main()
|
||||
|
|
|
@ -16,6 +16,8 @@ public:
|
|||
AsyncRPCOperation_saplingmigration& operator=(AsyncRPCOperation_saplingmigration const&) = delete; // Copy assign
|
||||
AsyncRPCOperation_saplingmigration& operator=(AsyncRPCOperation_saplingmigration&&) = delete; // Move assign
|
||||
|
||||
static libzcash::SaplingPaymentAddress getMigrationDestAddress(const HDSeed& seed);
|
||||
|
||||
virtual void main();
|
||||
|
||||
virtual UniValue getStatus() const;
|
||||
|
@ -28,6 +30,4 @@ private:
|
|||
void setMigrationResult(int numTxCreated);
|
||||
|
||||
CAmount chooseAmount(const CAmount& availableFunds);
|
||||
|
||||
libzcash::SaplingPaymentAddress getMigrationDestAddress(const HDSeed& seed);
|
||||
};
|
||||
|
|
|
@ -27,6 +27,7 @@
|
|||
#include "asyncrpcoperation.h"
|
||||
#include "asyncrpcqueue.h"
|
||||
#include "wallet/asyncrpcoperation_mergetoaddress.h"
|
||||
#include "wallet/asyncrpcoperation_saplingmigration.h"
|
||||
#include "wallet/asyncrpcoperation_sendmany.h"
|
||||
#include "wallet/asyncrpcoperation_shieldcoinbase.h"
|
||||
|
||||
|
@ -3929,6 +3930,100 @@ UniValue z_setmigration(const UniValue& params, bool fHelp) {
|
|||
return NullUniValue;
|
||||
}
|
||||
|
||||
UniValue z_getmigrationstatus(const UniValue& params, bool fHelp) {
|
||||
if (!EnsureWalletIsAvailable(fHelp))
|
||||
return NullUniValue;
|
||||
if (fHelp || params.size() != 0)
|
||||
throw runtime_error(
|
||||
"z_getmigrationstatus\n"
|
||||
"Returns information about the status of the Sprout to Sapling migration.\n"
|
||||
"In the result a transactions is defined as finalized iff it has ten confirmations.\n"
|
||||
"Note: It is possible that manually created transactions invloving this wallet\n"
|
||||
"will be included in the result.\n"
|
||||
"\nResult:\n"
|
||||
"{\n"
|
||||
" \"enabled\": true|false, (boolean) Whether or not migration is enabled\n"
|
||||
" \"destination_address\": \"zaddr\", (string) The Sapling address which will receive Sprout funds\n"
|
||||
" \"unmigrated_amount\": nnn.n, (numeric) The total amount of unmigrated " + CURRENCY_UNIT +" \n"
|
||||
" \"unfinalized_migrated_amount\": nnn.n, (numeric) The total amount of unfinalized " + CURRENCY_UNIT + " \n"
|
||||
" \"finalized_migrated_amount\": nnn.n, (numeric) The total amount of finalized " + CURRENCY_UNIT + " \n"
|
||||
" \"finalized_migration_transactions\": nnn, (numeric) The number of migration transactions involving this wallet\n"
|
||||
" \"time_started\": ttt, (numeric, optional) The block time of the first migration transaction\n"
|
||||
" \"migration_txids\": [txids] (json array of strings) An array of all migration txids involving this wallet\n"
|
||||
"}\n"
|
||||
);
|
||||
LOCK2(cs_main, pwalletMain->cs_wallet);
|
||||
UniValue migrationStatus(UniValue::VOBJ);
|
||||
migrationStatus.push_back(Pair("enabled", pwalletMain->fSaplingMigrationEnabled));
|
||||
// The "destination_address" field MAY be omitted if the "-migrationaddress"
|
||||
// parameter is not set and no default address has yet been generated.
|
||||
// Note: The following function may return the default address even if it has not been added to the wallet
|
||||
auto destinationAddress = AsyncRPCOperation_saplingmigration::getMigrationDestAddress(pwalletMain->GetHDSeedForRPC());
|
||||
migrationStatus.push_back(Pair("destination_address", EncodePaymentAddress(destinationAddress)));
|
||||
// The values of "unmigrated_amount" and "migrated_amount" MUST take into
|
||||
// account failed transactions, that were not mined within their expiration
|
||||
// height.
|
||||
{
|
||||
std::vector<CSproutNotePlaintextEntry> sproutEntries;
|
||||
std::vector<SaplingNoteEntry> saplingEntries;
|
||||
pwalletMain->GetFilteredNotes(sproutEntries, saplingEntries, "", 1);
|
||||
CAmount unmigratedAmount = 0;
|
||||
for (const auto& sproutEntry : sproutEntries) {
|
||||
unmigratedAmount += sproutEntry.plaintext.value();
|
||||
}
|
||||
migrationStatus.push_back(Pair("unmigrated_amount", FormatMoney(unmigratedAmount)));
|
||||
}
|
||||
// "migration_txids" is a list of strings representing transaction IDs of all
|
||||
// known migration transactions involving this wallet, as lowercase hexadecimal
|
||||
// in RPC byte order.
|
||||
UniValue migrationTxids(UniValue::VARR);
|
||||
int currentHeight = chainActive.Height();
|
||||
CAmount unfinalizedMigratedAmount = 0;
|
||||
CAmount finalizedMigratedAmount = 0;
|
||||
int numFinalizedMigrationTxs = 0;
|
||||
uint64_t timeStarted = 0;
|
||||
for (const auto& txPair : pwalletMain->mapWallet) {
|
||||
CWalletTx tx = txPair.second;
|
||||
// A given transaction is defined as a migration transaction iff it has:
|
||||
// * one or more Sprout JoinSplits with nonzero vpub_new field; and
|
||||
// * no Sapling Spends, and;
|
||||
// * one or more Sapling Outputs.
|
||||
if (tx.vjoinsplit.size() > 0 && tx.vShieldedSpend.empty() && tx.vShieldedOutput.size() > 0) {
|
||||
CAmount migrationAmount = 0;
|
||||
for (const auto& js : tx.vjoinsplit) {
|
||||
migrationAmount += js.vpub_new;
|
||||
}
|
||||
if (migrationAmount == 0) {
|
||||
continue;
|
||||
}
|
||||
migrationTxids.push_back(txPair.first.ToString());
|
||||
CBlockIndex* blockIndex = mapBlockIndex[tx.hashBlock];
|
||||
// A transaction is "finalized" iff it has 10 confirmations.
|
||||
// TODO: subject to change, if the recommended number of confirmations changes.
|
||||
if (currentHeight >= blockIndex->nHeight + 10) {
|
||||
finalizedMigratedAmount += migrationAmount;
|
||||
++numFinalizedMigrationTxs;
|
||||
} else {
|
||||
unfinalizedMigratedAmount += migrationAmount;
|
||||
}
|
||||
// The value of "time_started" is the earliest Unix timestamp of any known
|
||||
// migration transaction involving this wallet; if there is no such transaction,
|
||||
// then the field is absent.
|
||||
if (timeStarted == 0 || timeStarted > blockIndex->GetBlockTime()) {
|
||||
timeStarted = blockIndex->GetBlockTime();
|
||||
}
|
||||
}
|
||||
}
|
||||
migrationStatus.push_back(Pair("unfinalized_migrated_amount", FormatMoney(unfinalizedMigratedAmount)));
|
||||
migrationStatus.push_back(Pair("finalized_migrated_amount", FormatMoney(finalizedMigratedAmount)));
|
||||
migrationStatus.push_back(Pair("finalized_migration_transactions", numFinalizedMigrationTxs));
|
||||
if (timeStarted > 0) {
|
||||
migrationStatus.push_back(Pair("time_started", timeStarted));
|
||||
}
|
||||
migrationStatus.push_back(Pair("migration_txids", migrationTxids));
|
||||
return migrationStatus;
|
||||
}
|
||||
|
||||
/**
|
||||
When estimating the number of coinbase utxos we can shield in a single transaction:
|
||||
1. Joinsplit description is 1802 bytes.
|
||||
|
@ -4683,6 +4778,7 @@ static const CRPCCommand commands[] =
|
|||
{ "wallet", "z_mergetoaddress", &z_mergetoaddress, false },
|
||||
{ "wallet", "z_sendmany", &z_sendmany, false },
|
||||
{ "wallet", "z_setmigration", &z_setmigration, false },
|
||||
{ "wallet", "z_getmigrationstatus", &z_getmigrationstatus, false },
|
||||
{ "wallet", "z_shieldcoinbase", &z_shieldcoinbase, false },
|
||||
{ "wallet", "z_getoperationstatus", &z_getoperationstatus, true },
|
||||
{ "wallet", "z_getoperationresult", &z_getoperationresult, true },
|
||||
|
|
Loading…
Reference in New Issue